Changeset 1988 for pjproject/trunk/pjnath/include/pjnath/ice_session.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/ice_session.h (modified) (16 diffs)

pjproject/trunk/pjnath/include/pjnath/ice_session.h

@@ -130 +130 @@
 
 /**
+ * Forward declaration for checklist.
+ */
+typedef struct pj_ice_sess_checklist pj_ice_sess_checklist;
+
+/**
  * This enumeration describes the type of an ICE candidate.
  */
@@ -192 +197 @@
 
 } pj_ice_sess_comp;
+
+
+/**
+ * Data structure to be attached to internal message processing.
+ */
+typedef struct pj_ice_msg_data
+{
+    unsigned    transport_id;
+    pj_bool_t   has_req_data;
+
+    union data {
+        struct request_data {
+            pj_ice_sess             *ice;
+            pj_ice_sess_checklist   *clist;
+            unsigned                 ckid;
+        } req;
+    } data;
+} pj_ice_msg_data;
 
 
@@ -205 +228 @@
 {
     /**
+     * The candidate type, as described in #pj_ice_cand_type enumeration.
+     */
+    pj_ice_cand_type     type;
+
+    /** 
+     * Status of this candidate. The value will be PJ_SUCCESS if candidate
+     * address has been resolved successfully, PJ_EPENDING when the address
+     * resolution process is in progress, or other value when the address 
+     * resolution has completed with failure.
+     */
+    pj_status_t          status;
+
+    /**
      * The component ID of this candidate. Note that component IDs starts
      * with one for RTP and two for RTCP. In other words, it's not zero
      * based.
      */
-    pj_uint32_t          comp_id;
-
-    /**
-     * The candidate type, as described in #pj_ice_cand_type enumeration.
-     */
-    pj_ice_cand_type     type;
+    pj_uint8_t           comp_id;
+
+    /**
+     * Transport ID to be used to send packets for this candidate.
+     */
+    pj_uint8_t           transport_id;
+
+    /**
+     * Local preference value, which typically is 65535.
+     */
+    pj_uint16_t          local_pref;
 
     /**
@@ -384 +425 @@
  * candidate pairs that an agent will use to generate checks.
  */
-typedef struct pj_ice_sess_checklist
+struct pj_ice_sess_checklist
 {
     /**
@@ -406 +447 @@
     pj_timer_entry           timer;
 
-} pj_ice_sess_checklist;
+};
 
 
@@ -431 +472 @@
      * @param ice           The ICE session.
      * @param comp_id       ICE component ID.
+     * @param transport_id  Transport ID.
      * @param pkt           The STUN packet.
      * @param size          The size of the packet.
@@ -437 +479 @@
      */
     pj_status_t (*on_tx_pkt)(pj_ice_sess *ice, unsigned comp_id, 
+                             unsigned transport_id,
                              const void *pkt, pj_size_t size,
                              const pj_sockaddr_t *dst_addr,
@@ -447 +490 @@
      * @param ice           The ICE session.
      * @param comp_id       ICE component ID.
+     * @param transport_id  Transport ID.
      * @param pkt           The whole packet.
      * @param size          Size of the packet.
@@ -454 +498 @@
      */
     void        (*on_rx_data)(pj_ice_sess *ice, unsigned comp_id,
+                              unsigned transport_id, 
                               void *pkt, pj_size_t size,
                               const pj_sockaddr_t *src_addr,
@@ -497 +542 @@
 
     unsigned             comp_id;       /**< Component ID.              */
+    unsigned             transport_id;  /**< Transport ID.              */
 
     pj_sockaddr          src_addr;      /**< Source address of request  */
@@ -553 +599 @@
     unsigned             rcand_cnt;                 /**< # of remote cand.  */
     pj_ice_sess_cand     rcand[PJ_ICE_MAX_CAND];    /**< Array of cand.     */
+
+    /* Array of transport datas */
+    pj_ice_msg_data      tp_data[4];
 
     /* List of eearly checks */
@@ -580 +629 @@
  */
 PJ_DECL(const char*) pj_ice_get_cand_type_name(pj_ice_cand_type type);
+
+
+/**
+ * This is a utility function to retrieve the string name for the
+ * particular role type.
+ *
+ * @param role          Role type.
+ *
+ * @return              The string representation of the role.
+ */
+PJ_DECL(const char*) pj_ice_sess_role_name(pj_ice_sess_role role);
 
 
@@ -686 +746 @@
  * @param ice           ICE session instance.
  * @param comp_id       Component ID of this candidate.
+ * @param transport_id  Transport ID to be used to send packets for this
+ *                      candidate.
  * @param type          Candidate type.
  * @param local_pref    Local preference for this candidate, which
@@ -700 +762 @@
 PJ_DECL(pj_status_t) pj_ice_sess_add_cand(pj_ice_sess *ice,
                                           unsigned comp_id,
+                                          unsigned transport_id,
                                           pj_ice_cand_type type,
                                           pj_uint16_t local_pref,
@@ -798 +861 @@
  * @param ice           The ICE session.
  * @param comp_id       Component ID.
+ * @param transport_id  Number to identify where this packet was received
+ *                      from. This parameter will be returned back to
+ *                      application in \a on_tx_pkt() callback.
  * @param pkt           Incoming packet.
  * @param pkt_size      Size of incoming packet.
@@ -807 +873 @@
 PJ_DECL(pj_status_t) pj_ice_sess_on_rx_pkt(pj_ice_sess *ice,
                                            unsigned comp_id,
+                                           unsigned transport_id,
                                            void *pkt,
                                            pj_size_t pkt_size,