Changeset 1098 for pjproject/trunk/pjmedia/include/pjmedia/transport.h

Timestamp:

Mar 23, 2007 4:34:20 PM (17 years ago)

Author:

bennylp

Message:

ICE (work in progress): integration with PJSUA

File:

• pjproject/trunk/pjmedia/include/pjmedia/transport.h (modified) (3 diffs)

pjproject/trunk/pjmedia/include/pjmedia/transport.h

@@ -179 +179 @@
 struct pjmedia_transport_op
 {
+    /**
+     * Get media socket info from the specified transport.
+     *
+     * Application should call #pjmedia_transport_get_info() instead
+     */
     pj_status_t (*get_info)(pjmedia_transport *tp,
                             pjmedia_sock_info *info);
@@ -255 +260 @@
 
 
+/** 
+ * Media transport type.
+ */
+typedef enum pjmedia_transport_type
+{
+    /** Media transport using standard UDP */
+    PJMEDIA_TRANSPORT_TYPE_UDP,
+
+    /** Media transport using ICE */
+    PJMEDIA_TRANSPORT_TYPE_ICE
+
+} pjmedia_transport_type;
+
+
 /**
  * This structure declares stream transport. A stream transport is called
@@ -263 +282 @@
 {
     /** Transport name (for logging purpose). */
-    char                  name[PJ_MAX_OBJ_NAME];
+    char                     name[PJ_MAX_OBJ_NAME];
+
+    /** Transport type. */
+    pjmedia_transport_type   type;
 
     /** Transport's "virtual" function table. */
-    pjmedia_transport_op *op;
+    pjmedia_transport_op    *op;
 };
 
 
+/**
+ * Get media socket info from the specified transport. The socket info
+ * contains information about the local address of this transport, and
+ * would be needed for example to fill in the "c=" and "m=" line of local 
+ * SDP.
+ *
+ * @param tp        The transport.
+ * @param info      Media socket info to be initialized.
+ *
+ * @return          PJ_SUCCESS on success.
+ */
 PJ_INLINE(pj_status_t) pjmedia_transport_get_info(pjmedia_transport *tp,
                                                   pjmedia_sock_info *info)