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

Timestamp:

Mar 5, 2006 11:53:36 AM (19 years ago)

Author:

bennylp

Message:

Added API to terminate dialog prematurely. Affect: dialog, invite sessions, evsub, and presence

File:

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

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

@@ -170 +170 @@
     pj_pool_t           *pool;                      /**< Dialog's pool.     */
     pjsip_inv_state      state;                     /**< Invite sess state. */
+    pjsip_status_code    cause;                     /**< Disconnect cause.  */
+    pj_bool_t            notify;                    /**< Internal.          */
     pjsip_dialog        *dlg;                       /**< Underlying dialog. */
     pjsip_role_e         role;                      /**< Invite role.       */
@@ -331 +333 @@
                                           unsigned options,
                                           pjsip_inv_session **p_inv);
+
+
+/**
+ * Forcefully terminate and destroy INVITE session, regardless of
+ * the state of the session. Note that this function should only be used
+ * when there is failure in the INVITE session creation. After the
+ * invite session has been created and initialized, normally application
+ * SHOULD use #pjsip_inv_end_session() to end the INVITE session instead.
+ *
+ * Note also that this function may terminate the underlying dialog, if
+ * there are no other sessions in the dialog.
+ *
+ * @param inv           The invite session.
+ * @param st_code       Status code for the reason of the termination.
+ * @param notify        If set to non-zero, then on_state_changed() 
+ *                      callback will be called.
+ *
+ * @return              PJ_SUCCESS if the INVITE session has been
+ *                      terminated.
+ */
+PJ_DECL(pj_status_t) pjsip_inv_terminate( pjsip_inv_session *inv,
+                                          int st_code,
+                                          pj_bool_t notify );