ast_sip_event_publisher_handler Struct Reference

Callbacks that event publisher handlers will define. More...

#include <res_pjsip_outbound_publish.h>

Collaboration diagram for ast_sip_event_publisher_handler:

Collaboration graph
[legend]

Data Fields

const char * event_name
 The name of the event this handler deals with.
struct {
   struct
ast_sip_event_publisher_handler *   next
next
int(* start_publishing )(struct ast_sip_outbound_publish *configuration, struct ast_sip_outbound_publish_client *client)
 Called when a publisher should start publishing.
int(* stop_publishing )(struct ast_sip_outbound_publish_client *client)
 Called when a publisher should stop publishing.

Detailed Description

Callbacks that event publisher handlers will define.

Definition at line 41 of file res_pjsip_outbound_publish.h.


Field Documentation

const char* event_name

struct { ... } next

Definition at line 66 of file res_pjsip_outbound_publish.h.

int(* start_publishing)(struct ast_sip_outbound_publish *configuration, struct ast_sip_outbound_publish_client *client)

Called when a publisher should start publishing.

Parameters:
configuration The outbound publish configuration, event-specific configuration is accessible using extended sorcery fields
client The publish client that can be used to send PUBLISH messages.
Return values:
0 success
-1 failure

Referenced by ast_sip_register_event_publisher_handler(), and sip_outbound_publish_synchronize().

Called when a publisher should stop publishing.

Parameters:
client The publish client that was used to send PUBLISH messages.
Return values:
0 success
-1 failure

Referenced by ast_sip_register_event_publisher_handler(), cancel_and_unpublish(), and sip_outbound_publish_synchronize().


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

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