Changeset 2855 for pjproject/trunk/pjsip/include/pjsip-ua/sip_regc.h

Timestamp:

Aug 5, 2009 6:41:23 PM (15 years ago)

Author:

nanang

Message:

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.

File:

• pjproject/trunk/pjsip/include/pjsip-ua/sip_regc.h (modified) (3 diffs)

pjproject/trunk/pjsip/include/pjsip-ua/sip_regc.h

@@ -167 +167 @@
  *                  be a SIP/SIPS URL.
  * @param ccnt      Number of contacts in the array.
- * @param contact   Array of contacts.
+ * @param contact   Array of contacts, each contact item must be formatted
+ *                  as described in 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.
  * @param expires   Default expiration interval (in seconds) to be applied for
  *                  contact URL that doesn't have expiration settings. If the
@@ -304 +312 @@
 /**
  * Update Contact details in the client registration structure. For each
- * contact URI, if the uri is not found in existing contact, it will be
- * added to the Contact list. If the URI matches existing contact, nothing
+ * contact, if the contact is not found in existing contact, it will be
+ * added to the Contact list. If it matches existing contact, nothing
  * will be added. This function will also mark existing contacts which
  * are not specified in the new contact list as to be removed, by adding
@@ -318 +326 @@
  * @param regc      The client registration structure.
  * @param ccnt      Number of contacts.
- * @param contact   Array of contact URIs.
+ * @param contact   Array of contacts, each contact item must be formatted
+ *                  as described in 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.
  * @return          PJ_SUCCESS if sucessfull.
  */