Changeset 283 for pjproject/trunk/pjsip/include/pjsip-simple/evsub.h

Timestamp:

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

Author:

bennylp

Message:

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

File:

• pjproject/trunk/pjsip/include/pjsip-simple/evsub.h (modified) (1 diff)

pjproject/trunk/pjsip/include/pjsip-simple/evsub.h

@@ -288 +288 @@
                                              pjsip_evsub **p_evsub);
 
+/**
+ * Forcefully destroy the subscription session. This function should only
+ * be called on special condition, such as when the subscription 
+ * initialization has failed. For other conditions, application MUST terminate
+ * the subscription by sending the appropriate un(SUBSCRIBE) or NOTIFY.
+ *
+ * @param sub           The event subscription.
+ * @param notify        Specify whether the state notification callback
+ *                      should be called.
+ *
+ * @return              PJ_SUCCESS if subscription session has been destroyed.
+ */
+PJ_DECL(pj_status_t) pjsip_evsub_terminate( pjsip_evsub *sub,
+                                            pj_bool_t notify );
+
 
 /**