Changeset 4562 for pjproject/trunk/pjsip/include/pjsip-ua/sip_inv.h

Timestamp:

Jul 15, 2013 4:23:31 AM (11 years ago)

Author:

ming

Message:

Re #817: Initial work for allowing application to respond to re-INVITE manually.

Patches integrated in this fix (with some modifications for adjustment to the current trunk):

• sip_inv-on_rx_reinvite.patch

Move the place where to call the callback so the callback will still be called when the re-invite contains no SDP

• sdp_neg_cancel_remote_offer

pjmedia_sdp_neg_cancel_remote_offer() is no longer necessary since pjmedia_sdp_neg_cancel_offer() can already handle that. Only integrate the chart for sdp negotiation doc.

• sip_inv-terminate-reinvite-tsx-on-cancel
• sip_inv-cancel_sdp_neg_on_sending_negative_reply_to_reinvite
• pjsip-allow_cancel_reinvite

File:

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

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

@@ -160 +160 @@
     void (*on_rx_offer)(pjsip_inv_session *inv,
                         const pjmedia_sdp_session *offer);
+
+    /**
+     * This callback is optional, and is called when the invite session has
+     * received a re-INVITE from the peer. It will be called after
+     * on_rx_offer() callback and works only for re-INVITEs. It allows more
+     * fine-grained control over the response to a re-INVITE, e.g. sending
+     * a provisional response first. Application can return PJ_SUCCESS and
+     * send a reply using the function #pjsip_inv_initial_answer() or
+     * #pjsip_inv_answer(), as with the initial INVITE. If application
+     * returns non-PJ_SUCCESS, it needs to set the SDP answer with
+     * #pjsip_inv_set_sdp_answer() and the re-INVITE will be answered
+     * automatically.
+     *
+     * @param inv       The invite session.
+     * @param offer     Remote offer.
+     * @param rdata     The received re-INVITE request.
+     *
+     * @return          - PJ_SUCCESS: application will answer the re-INVITE
+     *                    manually
+     *                  - non-PJ_SUCCESS: answer the re-INVITE automatically
+     *                    using the SDP set via #pjsip_inv_set_sdp_answer()
+     */
+    pj_status_t (*on_rx_reinvite)(pjsip_inv_session *inv,
+                                  const pjmedia_sdp_session *offer,
+                                  pjsip_rx_data *rdata);
 
     /**
@@ -699 +724 @@
 
 /**
- * Create a response message to the initial INVITE request. This function
- * can only be called for the initial INVITE request, as subsequent
- * re-INVITE request will be answered automatically.
+ * Create a response message to an INVITE request.
  *
  * @param inv           The UAS invite session.
@@ -798 +821 @@
 
 
+/**
+ * Create a CANCEL request for an ongoing re-INVITE transaction. If no
+ * provisional response has been received, the function will not create
+ * CANCEL request (the function will return PJ_SUCCESS but the \a p_tdata
+ * will contain NULL) because we cannot send CANCEL before receiving
+ * provisional response. If then a provisional response is received,
+ * the invite session will send CANCEL automatically.
+ *
+ * @param inv           The invite session.
+ * @param p_tdata       Pointer to receive the message to be created. Note
+ *                      that it's possible to receive NULL here while the
+ *                      function returns PJ_SUCCESS, see the description.
+ *
+ * @return              PJ_SUCCESS if termination is initiated.
+ */
+PJ_DECL(pj_status_t) pjsip_inv_cancel_reinvite( pjsip_inv_session *inv,
+                                                pjsip_tx_data **p_tdata );
+
 
 /**