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

Timestamp:

Jan 25, 2008 4:06:33 PM (15 years ago)

Author:

bennylp

Message:

Fixed doxygen comments everywhere

File:

• pjproject/trunk/pjsip/include/pjsip/sip_transport.h (modified) (1 diff)

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

@@ -920 +920 @@
  *
  *****************************************************************************/
-typedef void (*pjsip_rx_callback)(pjsip_endpoint*, pj_status_t, pjsip_rx_data *);
-typedef pj_status_t (*pjsip_tx_callback)(pjsip_endpoint*, pjsip_tx_data*);
+
+/**
+ * Type of callback to be called when transport manager receives incoming
+ * SIP message.
+ *
+ * @param ep        Endpoint.
+ * @param status    Receiption status.
+ * @param rd        Received packet.
+ */
+typedef void (*pjsip_rx_callback)(pjsip_endpoint *ep, pj_status_t status, 
+                                  pjsip_rx_data *rd);
+
+/**
+ * Type of callback to be called before transport manager is about
+ * to transmit SIP message.
+ *
+ * @param ep        Endpoint.
+ * @param td        Transmit data.
+ */
+typedef pj_status_t (*pjsip_tx_callback)(pjsip_endpoint *ep, pjsip_tx_data*td);
+
 /**
  * Create a transport manager. Normally application doesn't need to call