summaryrefslogtreecommitdiff
path: root/pjsip/include/pjsip/sip_dialog.h
diff options
context:
space:
mode:
authorNanang Izzuddin <nanang@teluu.com>2009-08-05 18:41:23 +0000
committerNanang Izzuddin <nanang@teluu.com>2009-08-05 18:41:23 +0000
commitd0c5ad00ee36fb9c0922734dbba059d69b9830dd (patch)
tree3eeffefcce4cb75a4f1a825b424434a8d62d9d00 /pjsip/include/pjsip/sip_dialog.h
parenta3dcee2a2b4e375e5f9efdac20896923f244d932 (diff)
Ticket #930:
- Updated semantic of contact param in functions pjsip_dlg_create_uac(), pjsip_dlg_create_uas(), pjsip_endpt_create_request() and also variable pjsua_acc.contact to be Contact header value (was Contact URI). - Updated docs related to above modifications. - Fixed pjsua_im_send() in generating contact header, it should use pjsua_acc.contact instead, if it is set. git-svn-id: http://svn.pjsip.org/repos/pjproject/trunk@2855 74dad513-b988-da41-8d7b-12977e46ad98
Diffstat (limited to 'pjsip/include/pjsip/sip_dialog.h')
-rw-r--r--pjsip/include/pjsip/sip_dialog.h30
1 files changed, 24 insertions, 6 deletions
diff --git a/pjsip/include/pjsip/sip_dialog.h b/pjsip/include/pjsip/sip_dialog.h
index 03098df6..6b748b3a 100644
--- a/pjsip/include/pjsip/sip_dialog.h
+++ b/pjsip/include/pjsip/sip_dialog.h
@@ -183,9 +183,18 @@ PJ_DECL(pj_bool_t) pjsip_method_creates_dialog(const pjsip_method *m);
*
* @param ua The user agent module instance.
* @param local_uri Dialog local URI (i.e. From header).
- * @param local_contact_uri Optional dialog local Contact URI.
- * If this argument is NULL, the Contact will be
- * taken from the local URI.
+ * @param local_contact Optional dialog local Contact to be put as Contact
+ * header value, hence the format must follow
+ * RFC 3261 Section 20.10:
+ * When the header field value contains a display
+ * name, the URI including all URI parameters is
+ * enclosed in "<" and ">". If no "<" and ">" are
+ * present, all parameters after the URI are header
+ * parameters, not URI parameters. The display name
+ * can be tokens, or a quoted string, if a larger
+ * character set is desired.
+ * If this argument is NULL, the Contact will be taken
+ * from the local URI.
* @param remote_uri Dialog remote URI (i.e. To header).
* @param target Optional initial remote target. If this argument
* is NULL, the initial target will be set to
@@ -196,7 +205,7 @@ PJ_DECL(pj_bool_t) pjsip_method_creates_dialog(const pjsip_method *m);
*/
PJ_DECL(pj_status_t) pjsip_dlg_create_uac( pjsip_user_agent *ua,
const pj_str_t *local_uri,
- const pj_str_t *local_contact_uri,
+ const pj_str_t *local_contact,
const pj_str_t *remote_uri,
const pj_str_t *target,
pjsip_dialog **p_dlg);
@@ -220,8 +229,17 @@ PJ_DECL(pj_status_t) pjsip_dlg_create_uac( pjsip_user_agent *ua,
* @param ua The user agent module instance.
* @param rdata The incoming request that creates the dialog,
* such as INVITE, SUBSCRIBE, or REFER.
- * @param contact Optional URI to be used as local Contact. If
- * this argument is NULL, the local contact will be
+ * @param contact Optional dialog local Contact to be put as Contact
+ * header value, hence the format must follow
+ * RFC 3261 Section 20.10:
+ * When the header field value contains a display
+ * name, the URI including all URI parameters is
+ * enclosed in "<" and ">". If no "<" and ">" are
+ * present, all parameters after the URI are header
+ * parameters, not URI parameters. The display name
+ * can be tokens, or a quoted string, if a larger
+ * character set is desired.
+ * If this argument is NULL, the local contact will be
* initialized from the value of To header in the
* request.
* @param p_dlg Pointer to receive the dialog.