kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-10-12 15:45:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

res_pjsip_pubsub: Add new pubsub module capabilities. (#82)

Browse Source 
The existing res_pjsip_pubsub APIs are somewhat limited in
what they can do. This adds a few API extensions that make
it possible for PJSIP pubsub modules to implement richer
features than is currently possible.

* Allow pubsub modules to get a handle to pjsip_rx_data on subscription
* Allow pubsub modules to run a callback when a subscription is renewed
* Allow pubsub modules to run a callback for outgoing NOTIFYs, with
  a handle to the tdata, so that modules can append their own headers
  to the NOTIFYs

This change does not add any features directly, but makes possible
several new features that will be added in future changes.

Resolves: #81
ASTERISK-30485 #close

Master-Only: True
This commit is contained in:
InterLinked1
2023-05-18 13:41:38 -04:00
committed by GitHub
parent cd2865175c
commit 659f2aae3a
2 changed files with 92 additions and 39 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
include/asterisk/res_pjsip_pubsub.h
View File

@@ -232,6 +232,8 @@ enum ast_sip_subscription_notify_reason {
#define AST_SIP_EXTEN_STATE_DATA "ast_sip_exten_state_data"
/*! Type used for conveying mailbox state */
#define AST_SIP_MESSAGE_ACCUMULATOR "ast_sip_message_accumulator"
/*! Type used for device feature synchronization */
#define AST_SIP_DEVICE_FEATURE_SYNC_DATA "ast_sip_device_feature_sync_data"
/*!
* \brief Data used to create bodies for NOTIFY/PUBLISH requests.
@@ -268,6 +270,18 @@ struct ast_sip_notifier {
* \return The response code to send to the SUBSCRIBE.
*/
int (*new_subscribe)(struct ast_sip_endpoint *endpoint, const char *resource);
/*!
* \brief Same as new_subscribe, but also pass a handle to the pjsip_rx_data
*
* \note If this callback exists, it will be executed, otherwise new_subscribe will be.
* Only use this if you need the rdata. Otherwise, use new_subscribe.
*
* \param endpoint The endpoint from which we received the SUBSCRIBE
* \param resource The name of the resource to which the subscription is being made
* \param rdata The pjsip_rx_data for incoming subscription
* \return The response code to send to the SUBSCRIBE.
*/
int (*new_subscribe_with_rdata)(struct ast_sip_endpoint *endpoint, const char *resource, pjsip_rx_data *rdata);
/*!
* \brief Called when an inbound subscription has been accepted.
*
@@ -282,6 +296,25 @@ struct ast_sip_notifier {
* \retval -1 Failure
*/
int (*subscription_established)(struct ast_sip_subscription *sub);
/*!
* \brief Called when a SUBSCRIBE arrives for an already active subscription.
*
* \param sub The existing subscription
* \retval 0 Success
* \retval -1 Failure
*/
int (*refresh_subscribe)(struct ast_sip_subscription *sub, pjsip_rx_data *rdata);
/*!
* \brief Optional callback to execute before sending outgoing NOTIFY requests.
* Because res_pjsip_pubsub creates the tdata internally, this allows modules
* to access the tdata if needed, e.g. to add custom headers.
*
* \param sub The existing subscription
* \param tdata The pjsip_tx_data to use for the outgoing NOTIFY
* \retval 0 Success
* \retval -1 Failure
*/
int (*notify_created)(struct ast_sip_subscription *sub, pjsip_tx_data *tdata);
/*!
* \brief Supply data needed to create a NOTIFY body.
*