Changeset 2589 for pjproject/trunk/pjnath/include/pjnath/turn_session.h

Timestamp:

Apr 13, 2009 8:54:10 AM (15 years ago)

Author:

bennylp

Message:

Ticket #780: Update TURN from draft 09 to draft 13:

• new rules for permissions:
  • permission must be created and refreshed explicitly with CreatePermission?
  • transmitting data does not refresh permission
• attributes changed/added: XOR-PEER-ADDRESS, XOR-RELAYED-ADDRESS, EVEN-PORT, DONT-FRAGMENT
• attribute(s) removed: REQUESTED-PROPS
• new status codes: 401 (Forbidden), 507 (Insufficient Capacity)
• removed status codes: 443 (Invalid IP address), 444 (Invalid Port), 508 (Insufficient Port Capacity)

File:

• pjproject/trunk/pjnath/include/pjnath/turn_session.h (modified) (2 diffs)

pjproject/trunk/pjnath/include/pjnath/turn_session.h

@@ -435 +435 @@
 PJ_DECL(void) pj_turn_session_set_log(pj_turn_session *sess,
                                       unsigned flags);
+
+
+/**
+ * Configure the SOFTWARE name to be sent in all STUN requests by the
+ * TURN session.
+ *
+ * @param sess      The TURN client session.
+ * @param sw        Software name string. If this argument is NULL or
+ *                  empty, the session will not include SOFTWARE attribute
+ *                  in STUN requests and responses.
+ *
+ * @return          PJ_SUCCESS on success, or the appropriate error code.
+ */
+PJ_DECL(pj_status_t) pj_turn_session_set_software_name(pj_turn_session *sess,
+                                                       const pj_str_t *sw);
 
 
@@ -520 +535 @@
 
 /**
+ * Create or renew permission in the TURN server for the specified peer IP
+ * addresses. Application must install permission for a particular (peer)
+ * IP address before it sends any data to that IP address, or otherwise
+ * the TURN server will drop the data.
+ *
+ * @param sess          The TURN client session.
+ * @param addr_cnt      Number of IP addresses.
+ * @param addr          Array of peer IP addresses. Only the address family
+ *                      and IP address portion of the socket address matter.
+ * @param options       Specify 1 to let the TURN client session automatically
+ *                      renew the permission later when they are about to
+ *                      expire.
+ *
+ * @return              PJ_SUCCESS if the operation has been successfully
+ *                      issued, or the appropriate error code. Note that
+ *                      the operation itself will complete asynchronously.
+ */
+PJ_DECL(pj_status_t) pj_turn_session_set_perm(pj_turn_session *sess,
+                                              unsigned addr_cnt,
+                                              const pj_sockaddr addr[],
+                                              unsigned options);
+
+
+/**
  * Send a data to the specified peer address via the TURN relay. This 
  * function will encapsulate the data as STUN Send Indication or TURN