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.
int(*const has_destination )(const struct ast_msg *msg)
 Return whether or not the message has a valid destination.
const char * name
 Name of the message handler.


Detailed Description

An external processor of received messages.

Since:
12.5.0

Definition at line 98 of file message.h.


Field Documentation

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

Referenced by msg_q_cb().

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

Referenced by ast_msg_has_destination(), and msg_q_cb().

const char* name


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

Generated on Thu Apr 16 06:35:25 2015 for Asterisk - The Open Source Telephony Project by  doxygen 1.5.6