ast_msg_handler Struct Reference

An external processor of received messages. More...

#include <message.h>

Data Fields
int(*const	handle_msg )(struct ast_msg *msg)
	The function callback that will handle the message. More...
int(*const	has_destination )(const struct ast_msg *msg)
	Return whether or not the message has a valid destination. More...
const char *	name
	Name of the message handler. More...

Detailed Description

An external processor of received messages.

Since

12.5.0

Definition at line 98 of file message.h.

Field Documentation

handle_msg

int(* const handle_msg) (struct ast_msg *msg)

The function callback that will handle the message.

Parameters

msg	The message to handle

Return values

0	The handler processed the message successfull
non-zero	The handler passed or could not process the message

Definition at line 112 of file message.h.

Referenced by msg_q_cb().

has_destination

int(* const has_destination) (const struct ast_msg *msg)

Return whether or not the message has a valid destination.

A message may be delivered to the dialplan and/or other locations, depending on whether or not other handlers have been registered. This function is called by the message core to determine if any handler can process a message.

Parameters

msg	The message to inspect

Return values

0	The message does not have a valid destination
1	The message has a valid destination

Definition at line 127 of file message.h.

Referenced by ast_msg_has_destination(), and msg_q_cb().

name

const char* name

Name of the message handler.

Definition at line 102 of file message.h.

Referenced by ast_msg_handler_register(), ast_msg_handler_unregister(), ast_msg_has_destination(), PathSegment::get_child(), Parameter::load(), SwaggerType::load(), Property::load(), msg_handler_cmp(), msg_handler_find_by_tech_name(), and msg_q_cb().

---

The documentation for this struct was generated from the following file:

• message.h