Changeset 230 for pjproject/trunk/pjsip/include/pjsip/sip_endpoint.h

Timestamp:

Feb 25, 2006 9:16:36 PM (18 years ago)

Author:

bennylp

Message:

Tidying up and make it consistent with the documentation

File:

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

pjproject/trunk/pjsip/include/pjsip/sip_endpoint.h

@@ -46 +46 @@
  *  - it manages listeners and transports, and how they are used by 
  *    transactions.
- *  - it owns transaction hash table.
  *  - it receives incoming messages from transport layer and automatically
  *    dispatches them to the correct transaction (or create a new one).
@@ -53 +52 @@
  *  - it provides single polling function for all objects and distributes 
  *    events.
- *  - it provides SIP policy such as which outbound proxy to use for all
- *    outgoing SIP request messages.
  *  - it automatically handles incoming requests which can not be handled by
  *    existing modules (such as when incoming request has unsupported method).
@@ -142 +139 @@
 PJ_DECL(void) pjsip_endpt_cancel_timer( pjsip_endpoint *endpt, 
                                         pj_timer_entry *entry );
-
-
-/**
- * Dump endpoint status to the log. This will print the status to the log
- * with log level 3.
- *
- * @param endpt         The endpoint.
- * @param detail        If non zero, then it will dump a detailed output.
- *                      BEWARE that this option may crash the system because
- *                      it tries to access all memory pools.
- */
-PJ_DECL(void) pjsip_endpt_dump( pjsip_endpoint *endpt, pj_bool_t detail );
 
 
@@ -395 +380 @@
 /**
  * Get list of additional headers to be put in outgoing request message.
+ * Currently only Max-Forwards are defined.
  *
  * @param e         The endpoint.
@@ -404 +390 @@
 
 /**
- * Set list of SIP proxies to be visited for all outbound request messages.
- * Application can call this function to specify how outgoing request messages
- * should be routed. For example, if outgoing requests should go through an
- * outbound proxy, then application can specify the URL of the proxy when
- * calling this function. More than one proxy can be specified, and the
- * order of which proxy is specified when calling this function specifies
- * the order of which proxy will be visited first by the request messages.
- *
- * @param endpt     The endpoint instance.
- * @param url_cnt   Number of proxies/URLs in the array.
- * @param url       Array of proxy URL, which specifies the order of which
- *                  proxy will be visited first (e.g. url[0] will be visited
- *                  before url[1]).
- *
- * @return          Zero on success.
- */
-PJ_DECL(pj_status_t) pjsip_endpt_set_proxies( pjsip_endpoint *endpt,
-                                              int url_cnt, const pj_str_t url[]);
-
-/**
- * Get the list of "Route" header that are configured for this endpoint.
- * The "Route" header specifies how outbound request messages will be sent,
- * and is built when application sets the outbound proxy.
- *
- * @param endpt     The endpoint instance.
- *
- * @return          List of "Route" header.
- */
-PJ_DECL(const pjsip_route_hdr*) pjsip_endpt_get_routing( pjsip_endpoint *endpt );
+ * Dump endpoint status to the log. This will print the status to the log
+ * with log level 3.
+ *
+ * @param endpt         The endpoint.
+ * @param detail        If non zero, then it will dump a detailed output.
+ *                      BEWARE that this option may crash the system because
+ *                      it tries to access all memory pools.
+ */
+PJ_DECL(void) pjsip_endpt_dump( pjsip_endpoint *endpt, pj_bool_t detail );
+
+
 
 /**