[asterisk-commits] mmichelson: branch mmichelson/sip_transfer r388015 - /team/mmichelson/sip_tra...

[SVN commits to the Asterisk project]

Author: mmichelson
Date: Wed May  8 14:05:39 2013
New Revision: 388015

URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=388015
Log:
Add some documentation about the blind transfer callback and its associated structure.


Modified:
    team/mmichelson/sip_transfer/channels/chan_sip.c

Modified: team/mmichelson/sip_transfer/channels/chan_sip.c
URL: http://svnview.digium.com/svn/asterisk/team/mmichelson/sip_transfer/channels/chan_sip.c?view=diff&rev=388015&r1=388014&r2=388015
==============================================================================
--- team/mmichelson/sip_transfer/channels/chan_sip.c (original)
+++ team/mmichelson/sip_transfer/channels/chan_sip.c Wed May  8 14:05:39 2013
@@ -26223,14 +26223,34 @@
 	return 1;
 }
 
+/*!
+ * Data to set on a channel that runs dialplan
+ * at the completion of a blind transfer
+ */
 struct blind_transfer_cb_data {
+	/*! Contents of the REFER's Referred-by header */
 	const char *referred_by;
+	/*! Domain of the URI in the REFER's Refer-To header */
 	const char *domain;
+	/*! Contents of what to place in a Replaces header of an INVITE */
 	char replaces[SIPBUFSIZE];
+	/*! Redirecting information to set on the channel */
 	struct ast_party_redirecting redirecting;
+	/*! Parts of the redirecting structure that are to be updated */
 	struct ast_set_party_redirecting update_redirecting;
 };
 
+/*!
+ * \internal
+ * \brief Callback called on new outbound channel during blind transfer
+ *
+ * We use this opportunity to populate the channel with data from the REFER
+ * so that, if necessary, we can include proper information on any new INVITE
+ * we may send out.
+ *
+ * \param chan The new outbound channel
+ * \user_data A blind_transfer_cb_data struct
+ */
 static void blind_transfer_cb(struct ast_channel *chan, void *user_data)
 {
 	struct blind_transfer_cb_data *cb_data = user_data;