From 14a985560ed5830aa3e1b5880890a59a5d0f0c2f Mon Sep 17 00:00:00 2001 From: Mark Michelson Date: Mon, 4 Jun 2012 20:26:12 +0000 Subject: Merge changes dealing with support for Digium phones. Presence support has been added. This is accomplished by allowing for presence hints in addition to device state hints. A dialplan function called PRESENCE_STATE has been added to allow for setting and reading presence. Presence can be transmitted to Digium phones using custom XML elements in a PIDF presence document. Voicemail has new APIs that allow for moving, removing, forwarding, and playing messages. Messages have had a new unique message ID added to them so that the APIs will work reliably. The state of a voicemail mailbox can be obtained using an API that allows one to get a snapshot of the mailbox. A voicemail Dialplan App called VoiceMailPlayMsg has been added to be able to play back a specific message. Configuration hooks have been added. Configuration hooks allow for a piece of code to be executed when a specific configuration file is loaded by a specific module. This is useful for modules that are dependent on the configuration of other modules. chan_sip now has a public method that allows for a custom SIP INFO request to be sent mid-dialog. Digium phones use this in order to display progress bars when files are played. Messaging support has been expanded a bit. The main visible difference is the addition of an AMI action MessageSend. Finally, a ParkingLots manager action has been added in order to get a list of parking lots. git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@368435 65c4cc65-6c06-0410-ace0-fbb531ad65f3 --- include/asterisk/message.h | 30 +++++++++++++++++++++++++++++- 1 file changed, 29 insertions(+), 1 deletion(-) (limited to 'include/asterisk/message.h') diff --git a/include/asterisk/message.h b/include/asterisk/message.h index d989563e5..31ed0b28a 100644 --- a/include/asterisk/message.h +++ b/include/asterisk/message.h @@ -113,6 +113,11 @@ struct ast_msg *ast_msg_alloc(void); */ struct ast_msg *ast_msg_destroy(struct ast_msg *msg); +/*! + * \brief Bump a msg's ref count + */ +struct ast_msg *ast_msg_ref(struct ast_msg *msg); + /*! * \brief Set the 'to' URI of a message * @@ -159,7 +164,7 @@ int __attribute__((format(printf, 2, 3))) ast_msg_set_exten(struct ast_msg *msg, const char *fmt, ...); /*! - * \brief Set a variable on the message + * \brief Set a variable on the message going to the dialplan. * \note Setting a variable that already exists overwrites the existing variable value * * \param name Name of variable to set @@ -170,6 +175,18 @@ int __attribute__((format(printf, 2, 3))) */ int ast_msg_set_var(struct ast_msg *msg, const char *name, const char *value); +/*! + * \brief Set a variable on the message being sent to a message tech directly. + * \note Setting a variable that already exists overwrites the existing variable value + * + * \param name Name of variable to set + * \param value Value of variable to set + * + * \retval 0 success + * \retval -1 failure + */ +int ast_msg_set_var_outbound(struct ast_msg *msg, const char *name, const char *value); + /*! * \brief Get the specified variable on the message * \note The return value is valid only as long as the ast_message is valid. Hold a reference @@ -200,6 +217,17 @@ const char *ast_msg_get_body(const struct ast_msg *msg); */ int ast_msg_queue(struct ast_msg *msg); +/*! + * \brief Send a msg directly to an endpoint. + * + * Regardless of the return value of this function, this funciton will take + * care of ensuring that the message object is properly destroyed when needed. + * + * \retval 0 message successfully queued to be sent out + * \retval non-zero failure, message not get sent out. + */ +int ast_msg_send(struct ast_msg *msg, const char *to, const char *from); + /*! * \brief Opaque iterator for msg variables */ -- cgit v1.2.3