Changeset 515 for pjproject/trunk/pjsip/include/pjsip/sip_transport.h

Timestamp:

Jun 17, 2006 4:08:30 AM (18 years ago)

Author:

bennylp

Message:

Modifications all over the place, but mainly only to update Doxygen documentation

File:

• pjproject/trunk/pjsip/include/pjsip/sip_transport.h (modified) (7 diffs)

pjproject/trunk/pjsip/include/pjsip/sip_transport.h

@@ -35 +35 @@
 
 /**
- * @defgroup PJSIP_TRANSPORT SIP Transport
- * @ingroup PJSIP
- *
- * This is the low-level transport layer. Application normally won't need to 
- * use this function, but instead can use transaction or higher layer API to
- * send and receive messages.
+ * @defgroup PJSIP_TRANSPORT Transport
+ * @ingroup PJSIP_CORE
+ * @brief This is the transport framework.
+ *
+ * The transport framework is fully extensible. Please see
+ * <A HREF="/docs.htm">PJSIP Developer's Guide</A> PDF
+ * document for more information.
+ *
+ * Application MUST register at least one transport to PJSIP before any
+ * messages can be sent or received. Please see @ref PJSIP_TRANSPORT_UDP
+ * on how to create/register UDP transport to the transport framework.
  *
  * @{
@@ -138 +143 @@
 typedef struct pjsip_rx_data_op_key
 {
-    pj_ioqueue_op_key_t         op_key;
-    pjsip_rx_data              *rdata;
+    pj_ioqueue_op_key_t         op_key; /**< ioqueue op_key.            */
+    pjsip_rx_data              *rdata;  /**< rdata associated with this */
 } pjsip_rx_data_op_key;
 
@@ -304 +309 @@
 typedef struct pjsip_tx_data_op_key
 {
+    /** ioqueue pending operation key. */
     pj_ioqueue_op_key_t     key;
+
+    /** Transmit data associated with this key. */
     pjsip_tx_data          *tdata;
+
+    /** Arbitrary token (attached by transport) */
     void                   *token;
+
+    /** Callback to be called when pending transmit operation has
+        completed.
+     */
     void                  (*callback)(pjsip_transport*,void*,pj_ssize_t);
 } pjsip_tx_data_op_key;
@@ -377 +391 @@
     /** Transport manager internal. */
     void                *token;
+
+    /** Callback to be called when this tx_data has been transmitted.   */
     void               (*cb)(void*, pjsip_tx_data*, pj_ssize_t);
 
@@ -593 +609 @@
 struct pjsip_tpfactory
 {
-    /* This list is managed by transport manager. */
+    /** This list is managed by transport manager. */
     PJ_DECL_LIST_MEMBER(struct pjsip_tpfactory);
 
-    pj_pool_t              *pool;
-    pj_lock_t              *lock;
-
-    pjsip_transport_type_e  type;
-    char                    type_name[8];
-    unsigned                flag;
-
-    pj_sockaddr             local_addr;
-    pjsip_host_port         addr_name;
+    pj_pool_t              *pool;           /**< Owned memory pool.     */
+    pj_lock_t              *lock;           /**< Lock object.           */
+
+    pjsip_transport_type_e  type;           /**< Transport type.        */
+    char                    type_name[8];   /**< Type string name.      */
+    unsigned                flag;           /**< Transport flag.        */
+
+    pj_sockaddr             local_addr;     /**< Bound address.         */
+    pjsip_host_port         addr_name;      /**< Published name.        */
 
     /**
@@ -629 +645 @@
  *
  * @param mgr           The transport manager.
- * @param factory       Transport factory.
+ * @param tpf           Transport factory.
  *
  * @return              PJ_SUCCESS if listener was successfully created.
@@ -638 +654 @@
 /**
  * Unregister factory.
+ *
+ * @param mgr           The transport manager.
+ * @param tpf           Transport factory.
+ *
+ * @return              PJ_SUCCESS is sucessfully unregistered.
  */
 PJ_DECL(pj_status_t) pjsip_tpmgr_unregister_tpfactory(pjsip_tpmgr *mgr,