Changeset 1852 for pjproject/trunk/pjnath/include/pjnath/stun_session.h

Timestamp:

Mar 9, 2008 12:55:00 PM (16 years ago)

Author:

bennylp

Message:

More work for ticket #485: updated pjnath with TURN-07 and added authentication in the server

File:

• pjproject/trunk/pjnath/include/pjnath/stun_session.h (modified) (3 diffs)

pjproject/trunk/pjnath/include/pjnath/stun_session.h

@@ -294 +294 @@
  * Create a STUN response message. After the message has been 
  * successfully created, application can send the message by calling 
- * pj_stun_session_send_msg().
+ * pj_stun_session_send_msg(). Alternatively application may use
+ * pj_stun_session_respond() to create and send response in one function
+ * call.
  *
  * @param sess      The STUN session instance.
@@ -316 +318 @@
                                                 pj_stun_tx_data **p_tdata);
 
-
 /**
  * Send STUN message to the specified destination. This function will encode
@@ -341 +342 @@
                                               unsigned addr_len,
                                               pj_stun_tx_data *tdata);
+
+/**
+ * Create and send STUN response message.
+ *
+ * @param sess      The STUN session instance.
+ * @param req       The STUN request message to be responded.
+ * @param err_code  Error code to be set in the response, if error response
+ *                  is to be created, according to pj_stun_status enumeration.
+ *                  This argument MUST be zero if successful response is
+ *                  to be created.
+ * @param err_msg   Optional pointer for the error message string, when
+ *                  creating error response. If the value is NULL and the
+ *                  \a err_code is non-zero, then default error message will
+ *                  be used.
+ * @param cache     Specify whether session should cache this response for
+ *                  future request retransmission. If TRUE, subsequent request
+ *                  retransmission will be handled by the session and it 
+ *                  will not call request callback.
+ * @param dst_addr  Destination address of the response (or equal to the
+ *                  source address of the original request).
+ * @param addr_len  Address length.
+ *
+ * @return          PJ_SUCCESS on success, or the appropriate error code.
+ */
+PJ_DECL(pj_status_t) pj_stun_session_respond(pj_stun_session *sess, 
+                                             const pj_stun_msg *req,
+                                             unsigned code, 
+                                             const char *err_msg,
+                                             pj_bool_t cache, 
+                                             const pj_sockaddr_t *dst_addr, 
+                                             unsigned addr_len);
 
 /**