diff options
Diffstat (limited to 'include/asterisk')
| -rw-r--r-- | include/asterisk/res_pjsip_body_generator_types.h | 61 | ||||
| -rw-r--r-- | include/asterisk/res_pjsip_exten_state.h | 94 | ||||
| -rw-r--r-- | include/asterisk/res_pjsip_pubsub.h | 189 |
3 files changed, 241 insertions, 103 deletions
diff --git a/include/asterisk/res_pjsip_body_generator_types.h b/include/asterisk/res_pjsip_body_generator_types.h new file mode 100644 index 000000000..f27e8968a --- /dev/null +++ b/include/asterisk/res_pjsip_body_generator_types.h @@ -0,0 +1,61 @@ +/* + * Asterisk -- An open source telephony toolkit. + * + * Copyright (C) 2014, Digium, Inc. + * + * Mark Michelson <mmichelson@digium.com> + * + * See http://www.asterisk.org for more information about + * the Asterisk project. Please do not directly contact + * any of the maintainers of this project for assistance; + * the project provides a web site, mailing lists and IRC + * channels for your use. + * + * This program is free software, distributed under the terms of + * the GNU General Public License Version 2. See the LICENSE file + * at the top of the source tree. + */ + +#ifndef _RES_PJSIP_BODY_GENERATOR_TYPES_H +#define _RES_PJSIP_BODY_GENERATOR_TYPES_H + +#include "asterisk/pbx.h" + +/*! + * \brief structure used for presence XML bodies + * + * This is used for the following body types: + * \li application/pidf+xml + * \li application/xpidf+xml + * \li application/cpim-pidf+xml + */ +struct ast_sip_exten_state_data { + /*! The extension of the current state change */ + const char *exten; + /*! The extension state of the change */ + enum ast_extension_states exten_state; + /*! The presence state of the change */ + enum ast_presence_state presence_state; + /*! Current device state information */ + struct ao2_container *device_state_info; + /*! Local dialog URI */ + char local[PJSIP_MAX_URL_SIZE]; + /*! Remote dialog URI */ + char remote[PJSIP_MAX_URL_SIZE]; + /*! Allocation pool */ + pj_pool_t *pool; +}; + +/*! + * \brief Message counter used for message-summary XML bodies + * + * This is used for application/simple-message-summary bodies. + */ +struct ast_sip_message_accumulator { + /*! Number of old messages */ + int old_msgs; + /*! Number of new messages */ + int new_msgs; +}; + +#endif /* _RES_PJSIP_BODY_GENERATOR_TYPES_H */ diff --git a/include/asterisk/res_pjsip_exten_state.h b/include/asterisk/res_pjsip_exten_state.h deleted file mode 100644 index 6a324a4f4..000000000 --- a/include/asterisk/res_pjsip_exten_state.h +++ /dev/null @@ -1,94 +0,0 @@ -/* - * Asterisk -- An open source telephony toolkit. - * - * Copyright (C) 2013, Digium, Inc. - * - * Kevin Harwell <kharwell@digium.com> - * - * See http://www.asterisk.org for more information about - * the Asterisk project. Please do not directly contact - * any of the maintainers of this project for assistance; - * the project provides a web site, mailing lists and IRC - * channels for your use. - * - * This program is free software, distributed under the terms of - * the GNU General Public License Version 2. See the LICENSE file - * at the top of the source tree. - */ - -#ifndef _RES_PJSIP_EXTEN_STATE_H -#define _RES_PJSIP_EXTEN_STATE_H - -#include "asterisk/stringfields.h" -#include "asterisk/linkedlists.h" - -#include "asterisk/pbx.h" -#include "asterisk/presencestate.h" - - -/*! - * \brief Contains information pertaining to extension/device state changes. - */ -struct ast_sip_exten_state_data { - /*! The extension of the current state change */ - const char *exten; - /*! The extension state of the change */ - enum ast_extension_states exten_state; - /*! The presence state of the change */ - enum ast_presence_state presence_state; - /*! Current device state information */ - struct ao2_container *device_state_info; -}; - -/*! - * \brief Extension state provider. - */ -struct ast_sip_exten_state_provider { - /*! The name of the event this provider registers for */ - const char *event_name; - /*! Type of the body, ex: "application" */ - const char *type; - /*! Subtype of the body, ex: "pidf+xml" */ - const char *subtype; - /*! Type/Subtype together - ex: application/pidf+xml */ - const char *body_type; - /*! Subscription handler to be used and associated with provider */ - struct ast_sip_subscription_handler *handler; - - /*! - * \brief Create the body text of a NOTIFY request. - * - * Implementors use this to create body information within the given - * ast_str. That information is then added to the NOTIFY request. - * - * \param data Current extension state changes - * \param local URI of the dialog's local party, e.g. 'from' - * \param remote URI of the dialog's remote party, e.g. 'to' - * \param body_text Out parameter used to populate the NOTIFY msg body - * \retval 0 Successfully created the body's text - * \retval -1 Failed to create the body's text - */ - int (*create_body)(struct ast_sip_exten_state_data *data, const char *local, - const char *remote, struct ast_str **body_text); - - /*! Next item in the list */ - AST_LIST_ENTRY(ast_sip_exten_state_provider) next; -}; - -/*! - * \brief Registers an extension state provider. - * - * \param obj An extension state provider - * \retval 0 Successfully registered the extension state provider - * \retval -1 Failed to register the extension state provider - */ -int ast_sip_register_exten_state_provider(struct ast_sip_exten_state_provider *obj); - -/*! - * \brief Unregisters an extension state provider. - * - * \param obj An extension state provider - */ -void ast_sip_unregister_exten_state_provider(struct ast_sip_exten_state_provider *obj); - -#endif /* _RES_PJSIP_EXTEN_STATE_H */ diff --git a/include/asterisk/res_pjsip_pubsub.h b/include/asterisk/res_pjsip_pubsub.h index 2f676f193..0b0a49e66 100644 --- a/include/asterisk/res_pjsip_pubsub.h +++ b/include/asterisk/res_pjsip_pubsub.h @@ -226,23 +226,22 @@ struct ast_sip_subscription_response_data { struct ast_sip_subscription_handler { /*! The name of the event this handler deals with */ const char *event_name; - /*! The types of body this handler accepts */ + /*! The types of body this handler accepts. + * + * \note This option has no bearing when the handler is used in the + * notifier role. When in a subscriber role, this header is used to + * populate the Accept: header of an outbound SUBSCRIBE request + */ const char *accept[AST_SIP_MAX_ACCEPT]; /*! - * \brief Indicates if this handler can be used as a default handler for an event type. + * \brief Default body type defined for the event package this handler handles. * * Typically, a SUBSCRIBE request will contain one or more Accept headers that tell * what format they expect the body of NOTIFY requests to use. However, every event * package is required to define a default body format type to be used if a SUBSCRIBE * request for the event contains no Accept header. - * - * If this value is non-zero, then this handler provides the default body format for - * the event package and can handle SUBSCRIBES with no Accept headers present. - * If this value is zero, then this handler provides an alternative body format - * from the default for the event package and cannot handle SUBSCRIBEs with no - * Accept header. */ - unsigned int handles_default_accept; + const char *default_accept; /*! * \brief Called when a subscription is to be destroyed * @@ -537,4 +536,176 @@ int ast_sip_register_subscription_handler(struct ast_sip_subscription_handler *h */ void ast_sip_unregister_subscription_handler(struct ast_sip_subscription_handler *handler); +/*! + * \brief Pubsub body generator + * + * A body generator is responsible for taking Asterisk content + * and converting it into a body format to be placed in an outbound + * SIP NOTIFY or PUBLISH request. + */ +struct ast_sip_pubsub_body_generator { + /*! + * \brief Content type + * In "plain/text", "plain" is the type + */ + const char *type; + /*! + * \brief Content subtype + * In "plain/text", "text" is the subtype + */ + const char *subtype; + /*! + * \brief allocate body structure. + * + * Body generators will have this method called when a NOTIFY + * or PUBLISH body needs to be created. The type returned depends on + * the type of content being produced for the body. The data parameter + * is provided by the subscription handler and will vary between different + * event types. + * + * \param data The subscription data provided by the event handler + * \retval non-NULL The allocated body + * \retval NULL Failure + */ + void *(*allocate_body)(void *data); + /*! + * \brief Add content to the body of a SIP request + * + * The body of the request has already been allocated by the body generator's + * allocate_body callback. + * + * \param body The body of the SIP request. The type is determined by the + * content type. + * \param data The subscription data used to populate the body. The type is + * determined by the content type. + */ + int (*generate_body_content)(void *body, void *data); + /*! + * \brief Convert the body to a string. + * + * \param body The request body. + * \param str The converted string form of the request body + */ + void (*to_string)(void *body, struct ast_str **str); + /*! + * \brief Deallocate resources created for the body + * + * Optional callback to destroy resources allocated for the + * message body. + * + * \param body Body to be destroyed + */ + void (*destroy_body)(void *body); + AST_LIST_ENTRY(ast_sip_pubsub_body_generator) list; +}; + +/*! + * \brief Body supplement + * + * Body supplements provide additions to bodies not already + * provided by body generators. This may include proprietary + * extensions, optional content, or other nonstandard fare. + */ +struct ast_sip_pubsub_body_supplement { + /*! + * \brief Content type + * In "plain/text", "plain" is the type + */ + const char *type; + /*! + * \brief Content subtype + * In "plain/text", "text" is the subtype + */ + const char *subtype; + /*! + * \brief Add additional content to a SIP request body. + * + * A body generator will have already allocated a body and populated + * it with base data for the event. The supplement's duty is, if desired, + * to extend the body to have optional data beyond what a base RFC specifies. + * + * \param body The body of the SIP request. The type is determined by the + * body generator that allocated the body. + * \param data The subscription data used to populate the body. The type is + * determined by the content type. + */ + int (*supplement_body)(void *body, void *data); + AST_LIST_ENTRY(ast_sip_pubsub_body_supplement) list; +}; + +/*! + * \since 13.0.0 + * \brief Generate body content for a PUBLISH or NOTIFY + * + * This function takes a pre-allocated body and calls into registered body + * generators in order to fill in the body with appropriate details. + * The primary body generator will be called first, followed by the + * supplementary body generators + * + * \param content_type The content type of the body + * \param content_subtype The content subtype of the body + * \param data The data associated with body generation. + * \param[out] str The string representation of the generated body + * \retval 0 Success + * \retval non-zero Failure + */ +int ast_sip_pubsub_generate_body_content(const char *content_type, + const char *content_subtype, void *data, struct ast_str **str); + +/*! + * \since 13.0.0 + * \brief Register a body generator with the pubsub core. + * + * This may fail if an attempt is made to register a primary body supplement + * for a given content type if a primary body supplement for that content type + * has already been registered. + * + * \param generator Body generator to register + * \retval 0 Success + * \retval -1 Failure + */ +int ast_sip_pubsub_register_body_generator(struct ast_sip_pubsub_body_generator *generator); + +/*! + * \since 13.0.0 + * \brief Unregister a body generator with the pubsub core. + * + * \param generator Body generator to unregister + */ +void ast_sip_pubsub_unregister_body_generator(struct ast_sip_pubsub_body_generator *generator); + +/*! + * \since 13.0.0 + * \brief Register a body generator with the pubsub core. + * + * This may fail if an attempt is made to register a primary body supplement + * for a given content type if a primary body supplement for that content type + * has already been registered. + * + * \param generator Body generator to register + * \retval 0 Success + * \retval -1 Failure + */ +int ast_sip_pubsub_register_body_supplement(struct ast_sip_pubsub_body_supplement *supplement); + +/*! + * \since 13.0.0 + * \brief Unregister a body generator with the pubsub core. + * + * \param generator Body generator to unregister + */ +void ast_sip_pubsub_unregister_body_supplement(struct ast_sip_pubsub_body_supplement *supplement); + +/*! + * \since 13.0.0 + * \brief Get the body type used for this subscription + */ +const char *ast_sip_subscription_get_body_type(struct ast_sip_subscription *sub); + +/*! + * \since 13.0.0 + * \brief Get the body subtype used for this subscription + */ +const char *ast_sip_subscription_get_body_subtype(struct ast_sip_subscription *sub); + #endif /* RES_PJSIP_PUBSUB_H */ |