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

Timestamp:

Dec 30, 2005 11:50:15 PM (18 years ago)

Author:

bennylp

Message:

Basic module, transport, and sending messages

File:

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

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

@@ -368 +368 @@
 /**
  * Decrement reference counter of the transmit buffer.
- * When the transmit buffer is no longer used, it will be destroyed.
+ * When the transmit buffer is no longer used, it will be destroyed and
+ * caller is informed with PJSIP_EBUFDESTROYED return status.
  *
  * @param tdata     The transmit buffer data.
- */
-PJ_DECL(void) pjsip_tx_data_dec_ref( pjsip_tx_data *tdata );
+ * @return          This function will always succeeded eventhough the return
+ *                  status is non-zero. A status PJSIP_EBUFDESTROYED will be
+ *                  returned to inform that buffer is destroyed.
+ */
+PJ_DECL(pj_status_t) pjsip_tx_data_dec_ref( pjsip_tx_data *tdata );
 
 /**
@@ -378 +382 @@
  *
  * @param tdata     The transmit buffer.
+ * @return          Non-zero (PJ_TRUE) if buffer contains a valid message.
  */
 PJ_DECL(pj_bool_t) pjsip_tx_data_is_valid( pjsip_tx_data *tdata );
@@ -543 +548 @@
     /**
      * Create new outbound connection.
+     * Note that the factory is responsible for both creating the
+     * transport and registering it to the transport manager.
      */
     pj_status_t (*create_transport)(pjsip_tpfactory *factory,
@@ -548 +555 @@
                                     pjsip_endpoint *endpt,
                                     const pj_sockaddr *rem_addr,
+                                    int addr_len,
                                     pjsip_transport **transport);
 
@@ -622 +630 @@
  * suitable transport is found, a new one will be created.
  */
-PJ_DECL(pj_status_t) pjsip_tpmgr_alloc_transport( pjsip_tpmgr *mgr,
-                                                  pjsip_transport_type_e type,
-                                                  const pj_sockaddr_t *remote,
-                                                  int addr_len,
-                                                  pjsip_transport **p_transport );
+PJ_DECL(pj_status_t) pjsip_tpmgr_acquire_transport(pjsip_tpmgr *mgr,
+                                                   pjsip_transport_type_e type,
+                                                   const pj_sockaddr_t *remote,
+                                                   int addr_len,
+                                                   pjsip_transport **tp);