Changeset 797 for pjproject/trunk/pjsip/include/pjsip-ua/sip_xfer.h

Timestamp:

Nov 11, 2006 4:16:04 PM (17 years ago)

Author:

bennylp

Message:

Attended call transfer implementation. The changes involves:

• Added support for SIP Replaces extension (RFC 3891)
• Added pjsua_call_xfer_replaces() to perform attended call transfer.
• PJSUA checks and process Replaces header in incoming calls
• Added pjsip_ua_find_dialog() API.
• Added pjsip_endpt_has_capability() API.
• Added pjsip_endpt_send_response2() API.
• etc.

File:

• pjproject/trunk/pjsip/include/pjsip-ua/sip_xfer.h (modified) (1 diff)

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

@@ -30 +30 @@
 
 /**
- * @defgroup PJSUA_XFER Call Transfer
+ * @defgroup PJSUA_XFER SIP REFER (RFC 3515) for Call Transfer etc.
  * @ingroup PJSIP_HIGH_UA
- * @brief Provides call transfer functionality.
+ * @brief SIP REFER dialog usage (call transfer, etc.)
  * @{
  *
- * This implements call transfer functionality to INVITE sessions. The call
- * transfer functionality uses SIP Event Subscription framework for
- * managing call transfer status.
- *
- * Application must link with <b>pjsip-ua</b> AND <b>pjsip-simple</b> static
- * libraries to use call transfer functionality.
+ * This describes a generic handling of SIP REFER request. The SIP REFER
+ * request is described in RFC 3515, and commonly used to perform call
+ * transfer functionality. Other types of SIP REFER usages are described
+ * in draft-worley-sip-many-refers-00 draft, for example:
+ *  - Remote Dial: where UAC sends REFER to instruct REFER recipient to
+ *    initiate an INVITE session to some target.
+ * 
+ * A REFER request can be sent inside or outside existing dialog context,
+ * although for call transfer case, it is more common to send REFER inside
+ * existing INVITE session context. PJSIP supports both sending REFER request
+ * inside or outside dialog context.
+ *
+ * The REFER framework uses @ref PJSIP_EVENT_NOT to manage the event
+ * subscription created by the REFER request. Because of this, application 
+ * must link with <b>pjsip-ua</b> AND <b>pjsip-simple</b> static libraries 
+ * to use REFER functionality.
+ *
+ * Reference:
+ *  - <A HREF="http://www.ietf.org/rfc/rfc3515.txt">RFC 3515: The Session 
+ *    Initiation Protocol (SIP) Refer Method</A>
+ *  - @ref PJSIP_EVENT_NOT
  */