Changeset 1988 for pjproject/trunk/pjnath/include/pjnath/stun_transaction.h

Timestamp:

Jun 6, 2008 2:47:10 PM (16 years ago)

Author:

bennylp

Message:

Major major modifications related to ticket #485 (support for TURN-07):

• Added STUN socket transport pj_stun_sock
• Integration of TURN-07 to ICE
• Major refactoring in ICE stream transport to make it simpler
• Major modification (i.e. API change) in almost everywhere else
• Much more elaborate STUN, TURN, and ICE tests in pjnath-test

File:

• pjproject/trunk/pjnath/include/pjnath/stun_transaction.h (modified) (4 diffs)

pjproject/trunk/pjnath/include/pjnath/stun_transaction.h

@@ -90 +90 @@
      *
      * @return              If return value of the callback is not PJ_SUCCESS,
-     *                      the transaction will fail.
+     *                      the transaction will fail. Application MUST return
+     *                      PJNATH_ESTUNDESTROYED if it has destroyed the
+     *                      transaction in this callback.
      */
     pj_status_t (*on_send_msg)(pj_stun_client_tsx *tsx,
@@ -162 +164 @@
  * @param tsx           The STUN transaction.
  *
- * @return              PJ_SUCCESS on success, or the appropriate error code.
+ * @return              PJ_SUCCESS on success or PJ_EINVAL if the parameter
+ *                      is NULL.
  */
 PJ_DECL(pj_status_t) pj_stun_client_tsx_destroy(pj_stun_client_tsx *tsx);
@@ -215 +218 @@
  * @param pkt_len       Length of STUN packet.
  *
- * @return              PJ_SUCCESS on success or the appropriate error code.
+ * @return              PJ_SUCCESS on success, or PJNATH_ESTUNDESTROYED 
+ *                      when the user has destroyed the transaction in 
+ *                      \a on_send_msg() callback, or any other error code
+ *                      as returned by \a on_send_msg() callback.
  */
 PJ_DECL(pj_status_t) pj_stun_client_tsx_send_msg(pj_stun_client_tsx *tsx,
@@ -229 +235 @@
  * @param tsx           The STUN client transaction instance.
  *
- * @return              PJ_SUCCESS on success or the appropriate error code.
+ * @return              PJ_SUCCESS on success, or PJNATH_ESTUNDESTROYED 
+ *                      when the user has destroyed the transaction in 
+ *                      \a on_send_msg() callback, or any other error code
+ *                      as returned by \a on_send_msg() callback.
  */
 PJ_DECL(pj_status_t) pj_stun_client_tsx_retransmit(pj_stun_client_tsx *tsx);