Asterisk - The Open Source Telephony Project GIT-master-d856a3e
Data Fields
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
msgThe message to handle
Return values
0The handler processed the message successfull
non-zeroThe handler passed or could not process the message

Definition at line 112 of file message.h.

◆ 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
msgThe message to inspect
Return values
0The message does not have a valid destination
1The message has a valid destination

Definition at line 127 of file message.h.

◆ name

const char* name

Name of the message handler.

Definition at line 102 of file message.h.

Referenced by PathSegment::get_child(), Parameter::load(), Property::load(), SwaggerType::load(), and msg_handler_cmp().


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