http_client Update devel documentation
authorOlle E. Johansson <oej@edvina.net>
Mon, 2 Jan 2017 16:17:38 +0000 (17:17 +0100)
committerOlle E. Johansson <oej@edvina.net>
Mon, 2 Jan 2017 16:17:38 +0000 (17:17 +0100)
src/modules/http_client/doc/http_client_devel.xml

index 049d107..80bb99b 100644 (file)
        
        <title>&develguide;</title>
        <section>
+       This module provides a set of API functions that other modules can use in order to
+       integrate with HTTP services.
+       </section>
+       <section>
        <title>Available Functions</title>
                <section>
                        <title>
-                       <function moreinfo="none">http_connect(msg, connection, url, result, content_type, post)</function>
+                       <function moreinfo="none">int http_connect(msg, connection, url, result, content_type, post)</function>
                        </title>
                        <para>
                        Sends HTTP GET or POST request to a given connection. If content_type and post
                </section>
                <section>
                        <title>
-                       <function moreinfo="none">http_query(msg, url, dest, post)</function>
+                       <function moreinfo="none">int http_query(msg, url, dest, post)</function>
                        </title>
                        <para>
-                       Sends HTTP GET or POST request to a given connection. If post data 
+                       Sends HTTP GET or POST request to a given connection. If post data 
                        is defined, POST will be used, otherwise GET. The default settings
                        defined as module params of the http_client module will be used for
                        the connection.
                        <listitem>
                                <para><emphasis>struct sip_msg *msg</emphasis></para>
                                <para>
-                               The current sip message structure.
+                               The current SIP message structure.
                                </para>
                        </listitem>
                        <listitem>