Changeset 2966 for pjproject/trunk/pjnath/include/pjnath/turn_sock.h

Timestamp:

Oct 25, 2009 9:02:07 AM (15 years ago)

Author:

bennylp

Message:

Initial commit for ticket #950: QoS support:

• implementation:
  • PJLIB (sock_qos*.*)
• added QoS support in:
  • SIP UDP transport,
  • SIP TCP transport,
  • media UDP transport (done in pjsua-lib),
  • pjnath ICE stream transport,
  • pjnath STUN socket,
  • pjnath TURN client
• added QoS options in pjsua-lib:
  • QoS fields in pjsua_transport_config
• added "--set-qos" parameter in pjsua

Notes:

• QoS in TLS transport is not yet implemented, waiting for #957
• build ok on VS6, VS2005 (multiple targets), Carbide, and Mingw
• no run-time testing yet

File:

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

pjproject/trunk/pjnath/include/pjnath/turn_sock.h

@@ -26 +26 @@
  */
 #include <pjnath/turn_session.h>
+#include <pj/sock_qos.h>
 
 
@@ -99 +100 @@
 
 } pj_turn_sock_cb;
+
+
+/**
+ * This structure describes options that can be specified when creating
+ * the TURN socket. Application should call #pj_turn_sock_cfg_default()
+ * to initialize this structure with its default values before using it.
+ */
+typedef struct pj_turn_sock_cfg
+{
+    /**
+     * QoS traffic type to be set on this transport. When application wants
+     * to apply QoS tagging to the transport, it's preferable to set this
+     * field rather than \a qos_param fields since this is more portable.
+     *
+     * Default value is PJ_QOS_TYPE_BEST_EFFORT.
+     */
+    pj_qos_type qos_type;
+
+    /**
+     * Set the low level QoS parameters to the transport. This is a lower
+     * level operation than setting the \a qos_type field and may not be
+     * supported on all platforms.
+     *
+     * By default all settings in this structure are not set.
+     */
+    pj_qos_params qos_params;
+
+    /**
+     * Specify if STUN socket should ignore any errors when setting the QoS
+     * traffic type/parameters.
+     *
+     * Default: PJ_TRUE
+     */
+    pj_bool_t qos_ignore_error;
+
+} pj_turn_sock_cfg;
+
+
+/**
+ * Initialize pj_turn_sock_cfg structure with default values.
+ */
+PJ_DECL(void) pj_turn_sock_cfg_default(pj_turn_sock_cfg *cfg);
 
 
@@ -115 +158 @@
  *                      UDP are supported.
  * @param cb            Callback to receive events from the TURN transport.
- * @param options       Option flags, currently this value must be zero.
+ * @param setting       Optional settings to be specified to the transport.
+ *                      If this parameter is NULL, default values will be
+ *                      used.
  * @param user_data     Arbitrary application data to be associated with
  *                      this transport.
@@ -128 +173 @@
                                          pj_turn_tp_type conn_type,
                                          const pj_turn_sock_cb *cb,
-                                         unsigned options,
+                                         const pj_turn_sock_cfg *setting,
                                          void *user_data,
                                          pj_turn_sock **p_turn_sock);