Changeset 5828 for pjproject/trunk/pjsip/include/pjsua-lib/pjsua.h

Timestamp:

Jul 20, 2018 2:19:41 AM (6 years ago)

Author:

ming

Message:

Fixed #2128: Add feature to allow responding incoming INVITE/re-INVITE asynchronously and set the SDP answer

File:

• pjproject/trunk/pjsip/include/pjsua-lib/pjsua.h (modified) (3 diffs)

pjproject/trunk/pjsip/include/pjsua-lib/pjsua.h

@@ -1092 +1092 @@
      * current call setting.
      *
+     * Note: this callback may not be called if \a on_call_rx_reinvite()
+     * is implemented.
+     *
      * @param call_id   The call index.
      * @param offer     The new offer received.
@@ -1106 +1109 @@
                              pjsip_status_code *code,
                              pjsua_call_setting *opt);
+
+
+    /**
+     * Notify application when call has received a re-INVITE with offer
+     * from the peer. It allows more fine-grained control over the response
+     * to a re-INVITE. If application sets async to PJ_TRUE, it can send
+     * the reply manually using the function #pjsua_call_answer_with_sdp().
+     * Otherwise, by default the re-INVITE will be answered automatically
+     * after the callback returns.
+     *
+     * Currently, this callback is only called for re-INVITE with
+     * SDP, but app should be prepared to handle the case of re-INVITE
+     * without SDP.
+     *
+     * Remarks: If manually answering at a later timing, application may
+     * need to monitor on_call_tsx_state() callback to check whether
+     * the re-INVITE is already answered automatically with 487 due to
+     * being cancelled.
+     *
+     * Note: on_call_rx_offer() will still be called after this callback,
+     * but only if async is PJ_FALSE and code is 200. 
+     *
+     * @param call_id   The call index.
+     * @param offer     Remote offer.
+     * @param rdata     The received re-INVITE request.
+     * @param reserved  Reserved param, currently not used.
+     * @param async     On input, it is PJ_FALSE. Set to PJ_TRUE if
+     *                  app wants to manually answer the re-INVITE.
+     * @param code      Status code to be returned for answering the
+     *                  offer. On input, it contains status code 200.
+     *                  Currently, valid values are only 200 and 488.
+     * @param opt       The current call setting, application can update
+     *                  this setting for answering the offer.
+     */
+    void (*on_call_rx_reinvite)(pjsua_call_id call_id,
+                                const pjmedia_sdp_session *offer,
+                                pjsip_rx_data *rdata,
+                                void *reserved,
+                                pj_bool_t *async,
+                                pjsip_status_code *code,
+                                pjsua_call_setting *opt);
 
 
@@ -5123 +5167 @@
 
 /**
+ * Same as #pjsua_call_answer2() but this function will set the SDP
+ * answer first before sending the response.
+ *
+ * @param call_id       Incoming call identification.
+ * @param sdp           SDP answer. 
+ * @param opt           Optional call setting.
+ * @param code          Status code, (100-699).
+ * @param reason        Optional reason phrase. If NULL, default text
+ *                      will be used.
+ * @param msg_data      Optional list of headers etc to be added to outgoing
+ *                      response message. Note that this message data will
+ *                      be persistent in all next answers/responses for this
+ *                      INVITE request.
+ *
+ * @return              PJ_SUCCESS on success, or the appropriate error code.
+ */
+PJ_DECL(pj_status_t)
+pjsua_call_answer_with_sdp(pjsua_call_id call_id,
+                           const pjmedia_sdp_session *sdp, 
+                           const pjsua_call_setting *opt,
+                           unsigned code,
+                           const pj_str_t *reason,
+                           const pjsua_msg_data *msg_data);
+
+
+/**
  * Hangup call by using method that is appropriate according to the
  * call state. This function is different than answering the call with