Changeset 5556 for pjproject/trunk/pjsip/include/pjsip/sip_transport.h

Timestamp:

Feb 20, 2017 1:16:58 AM (7 years ago)

Author:

ming

Message:

Closed #1995: Add API pjsip_transport_shutdown2() to immediately disconnect a transport

File:

• pjproject/trunk/pjsip/include/pjsip/sip_transport.h (modified) (1 diff)

pjproject/trunk/pjsip/include/pjsip/sip_transport.h

@@ -904 +904 @@
 
 /**
+ * Start shutdown procedure for this transport. If \a force is false,
+ * the API is the same as #pjsip_transport_shutdown(), while
+ * if \a force is true, existing transport users will immediately
+ * receive PJSIP_TP_STATE_DISCONNECTED notification and should not
+ * use the transport anymore. In either case, transport will
+ * only be destroyed after all objects release their references.
+ *
+ * @param tp                The transport.
+ * @param force             Force transport to immediately send
+ *                          disconnection state notification.
+ *
+ * @return                  PJ_SUCCESS on success.
+ */
+PJ_DECL(pj_status_t) pjsip_transport_shutdown2(pjsip_transport *tp,
+                                               pj_bool_t force);
+
+/**
  * Destroy a transport when there is no object currently uses the transport.
  * This function is normally called internally by transport manager or the