ACKme / WiConnect

Host library for controlling a WiConnect enabled Wi-Fi module.

Dependents:   wiconnect-ota_example wiconnect-web_setup_example wiconnect-test-console wiconnect-tcp_server_example ... more

Diff: doc/html/group__api__socket__http.html

Revision:
13:2b51f5267c92
Parent:
11:ea484e1b7fc4
Child:
17:7268f365676b
--- a/doc/html/group__api__socket__http.html	Tue Aug 12 02:44:34 2014 -0700
+++ b/doc/html/group__api__socket__http.html	Wed Aug 13 03:14:30 2014 -0700
@@ -3,8 +3,9 @@
 <head>
 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
-<meta name="generator" content="Doxygen 1.8.7"/>
-<title>WiConnect Library: HTTP</title>
+<title>ACKme WiConnect Host Library</title>
+<link rel="icon" href="favicon.ico" type="image/x-icon">
+<link rel="shortcut icon" href="favicon.ico" type="image/x-icon">
 <link href="tabs.css" rel="stylesheet" type="text/css"/>
 <script type="text/javascript" src="jquery.js"></script>
 <script type="text/javascript" src="dynsections.js"></script>
@@ -24,29 +25,30 @@
 </head>
 <body>
 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
-<div id="titlearea">
-<table cellspacing="0" cellpadding="0">
- <tbody>
- <tr style="height: 56px;">
-  <td style="padding-left: 0.5em;">
-   <div id="projectname">WiConnect Library
-   </div>
-  </td>
- </tr>
- </tbody>
-</table>
-</div>
-<!-- end header part -->
-<!-- Generated by Doxygen 1.8.7 -->
+<div id="titlearea" style="font-family:verdana;">
+    <table border='0' cellpadding='0' cellspacing='0' width="98%">
+      <tr style="height:20px"><td>&nbsp;</td></tr>
+      <tr style="border-collapse: collapse; padding: 0;">
+        <td style="width:20px"></td>
+        <td style="padding-right:40px"><img src="ackmelogo.png" alt="ACKme Logo" /></td>
+        <td style="vertical-align:middle; text-align:left; font: bold 25px/100% Verdana, Arial, Helvetica, sans-serif;">
+        WiConnect Host Library- API Reference Guide</td>
+        <td style="width:20px"></td>
+      </tr>
+      <tr><td>&nbsp;</td></tr>
+    </table>
+</div><!-- Generated by Doxygen 1.8.7 -->
 <script type="text/javascript">
 var searchBox = new SearchBox("searchBox", "search",false,'Search');
 </script>
   <div id="navrow1" class="tabs">
     <ul class="tablist">
-      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
-      <li><a href="modules.html"><span>Modules</span></a></li>
-      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
+      <li><a href="index.html"><span>Library&#160;Overview</span></a></li>
+      <li><a href="modules.html"><span>Library&#160;API</span></a></li>
+      <li><a href="examples.html"><span>API&#160;Examples</span></a></li>
       <li><a href="annotated.html"><span>Classes</span></a></li>
+      <li><a href="http://wiconnect.ack.me/1.2/general_overview"><span>WiConnect&#160;Reference&#160;Manual</span></a></li>
+      <li><a href="http://www.ack.me/WiConnect"><span>ACKme&#160;Website</span></a></li>
       <li>
         <div id="MSearchBox" class="MSearchBoxInactive">
         <span class="left">
@@ -98,51 +100,326 @@
   <div class="summary">
 <a href="#func-members">Functions</a>  </div>
   <div class="headertitle">
-<div class="title">HTTP<div class="ingroups"><a class="el" href="group__api__socket.html">Socket API</a></div></div>  </div>
+<div class="title">HTTP Methods<div class="ingroups"><a class="el" href="group__api__socket.html">Socket</a></div></div>  </div>
 </div><!--header-->
 <div class="contents">
 
-<p>HTTP API methods.  
+<p>HTTP methods.  
 <a href="#details">More...</a></p>
 <table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
 Functions</h2></td></tr>
-<tr class="memitem:gab2d562c96f8f40d916fc1df1229f0e09"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gab2d562c96f8f40d916fc1df1229f0e09"></a>
-<a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__socket__http.html#gab2d562c96f8f40d916fc1df1229f0e09">wiconnect::SocketInterface::httpConnect</a> (<a class="el" href="classwiconnect_1_1_socket.html">Socket</a> &amp;socket, const char *url, const <a class="el" href="structwiconnect_1_1_http_socket_args.html">HttpSocketArgs</a> *args)</td></tr>
-<tr class="memdesc:gab2d562c96f8f40d916fc1df1229f0e09"><td class="mdescLeft">&#160;</td><td class="mdescRight">Connect to remote HTTP server. <br /></td></tr>
+<tr class="memitem:gab2d562c96f8f40d916fc1df1229f0e09"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__socket__http.html#gab2d562c96f8f40d916fc1df1229f0e09">wiconnect::SocketInterface::httpConnect</a> (<a class="el" href="classwiconnect_1_1_socket.html">Socket</a> &amp;socket, const char *url, const <a class="el" href="structwiconnect_1_1_http_socket_args.html">HttpSocketArgs</a> *args)</td></tr>
+<tr class="memdesc:gab2d562c96f8f40d916fc1df1229f0e09"><td class="mdescLeft">&#160;</td><td class="mdescRight">Connect to remote HTTP server.  <a href="#gab2d562c96f8f40d916fc1df1229f0e09">More...</a><br /></td></tr>
 <tr class="separator:gab2d562c96f8f40d916fc1df1229f0e09"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ga818f9fc3d616deb5ac009f001e5e611b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga818f9fc3d616deb5ac009f001e5e611b"></a>
-<a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__socket__http.html#ga818f9fc3d616deb5ac009f001e5e611b">wiconnect::SocketInterface::httpGet</a> (<a class="el" href="classwiconnect_1_1_socket.html">Socket</a> &amp;socket, const char *url, bool openOnly=false, const char *certFilename=NULL)</td></tr>
-<tr class="memdesc:ga818f9fc3d616deb5ac009f001e5e611b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Issue HTTP GET Request. <br /></td></tr>
+<tr class="memitem:ga818f9fc3d616deb5ac009f001e5e611b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__socket__http.html#ga818f9fc3d616deb5ac009f001e5e611b">wiconnect::SocketInterface::httpGet</a> (<a class="el" href="classwiconnect_1_1_socket.html">Socket</a> &amp;socket, const char *url, bool openOnly=false, const char *certFilename=NULL)</td></tr>
+<tr class="memdesc:ga818f9fc3d616deb5ac009f001e5e611b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Issue HTTP GET Request.  <a href="#ga818f9fc3d616deb5ac009f001e5e611b">More...</a><br /></td></tr>
 <tr class="separator:ga818f9fc3d616deb5ac009f001e5e611b"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:gaaa5cb3c4b27ed0f2002e81392606a756"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaaa5cb3c4b27ed0f2002e81392606a756"></a>
-<a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__socket__http.html#gaaa5cb3c4b27ed0f2002e81392606a756">wiconnect::SocketInterface::httpPost</a> (<a class="el" href="classwiconnect_1_1_socket.html">Socket</a> &amp;socket, const char *url, const char *contextType, bool openOnly=true, const char *certFilename=NULL)</td></tr>
-<tr class="memdesc:gaaa5cb3c4b27ed0f2002e81392606a756"><td class="mdescLeft">&#160;</td><td class="mdescRight">Issue HTTP POST Request. <br /></td></tr>
+<tr class="memitem:gaaa5cb3c4b27ed0f2002e81392606a756"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__socket__http.html#gaaa5cb3c4b27ed0f2002e81392606a756">wiconnect::SocketInterface::httpPost</a> (<a class="el" href="classwiconnect_1_1_socket.html">Socket</a> &amp;socket, const char *url, const char *contextType, bool openOnly=true, const char *certFilename=NULL)</td></tr>
+<tr class="memdesc:gaaa5cb3c4b27ed0f2002e81392606a756"><td class="mdescLeft">&#160;</td><td class="mdescRight">Issue HTTP POST Request.  <a href="#gaaa5cb3c4b27ed0f2002e81392606a756">More...</a><br /></td></tr>
 <tr class="separator:gaaa5cb3c4b27ed0f2002e81392606a756"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ga949cee4543c91951219652bd6282049f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga949cee4543c91951219652bd6282049f"></a>
-<a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__socket__http.html#ga949cee4543c91951219652bd6282049f">wiconnect::SocketInterface::httpHead</a> (<a class="el" href="classwiconnect_1_1_socket.html">Socket</a> &amp;socket, const char *url, const char *certFilename=NULL)</td></tr>
-<tr class="memdesc:ga949cee4543c91951219652bd6282049f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Issue HTTP HEAD Request. <br /></td></tr>
+<tr class="memitem:ga949cee4543c91951219652bd6282049f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__socket__http.html#ga949cee4543c91951219652bd6282049f">wiconnect::SocketInterface::httpHead</a> (<a class="el" href="classwiconnect_1_1_socket.html">Socket</a> &amp;socket, const char *url, const char *certFilename=NULL)</td></tr>
+<tr class="memdesc:ga949cee4543c91951219652bd6282049f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Issue HTTP HEAD Request.  <a href="#ga949cee4543c91951219652bd6282049f">More...</a><br /></td></tr>
 <tr class="separator:ga949cee4543c91951219652bd6282049f"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ga2b3fd9a84f173312318e2bb22cef2004"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga2b3fd9a84f173312318e2bb22cef2004"></a>
-<a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__socket__http.html#ga2b3fd9a84f173312318e2bb22cef2004">wiconnect::SocketInterface::httpAddHeader</a> (<a class="el" href="classwiconnect_1_1_socket.html">Socket</a> &amp;socket, const char *key, const char *value)</td></tr>
-<tr class="memdesc:ga2b3fd9a84f173312318e2bb22cef2004"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add HTTP header key/value pair to opened HTTP request. <br /></td></tr>
+<tr class="memitem:ga2b3fd9a84f173312318e2bb22cef2004"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__socket__http.html#ga2b3fd9a84f173312318e2bb22cef2004">wiconnect::SocketInterface::httpAddHeader</a> (<a class="el" href="classwiconnect_1_1_socket.html">Socket</a> &amp;socket, const char *key, const char *value)</td></tr>
+<tr class="memdesc:ga2b3fd9a84f173312318e2bb22cef2004"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add HTTP header key/value pair to opened HTTP request.  <a href="#ga2b3fd9a84f173312318e2bb22cef2004">More...</a><br /></td></tr>
 <tr class="separator:ga2b3fd9a84f173312318e2bb22cef2004"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ga0cad302f741f3f58a2fda54b67110a70"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga0cad302f741f3f58a2fda54b67110a70"></a>
-<a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__socket__http.html#ga0cad302f741f3f58a2fda54b67110a70">wiconnect::SocketInterface::httpGetStatus</a> (<a class="el" href="classwiconnect_1_1_socket.html">Socket</a> &amp;socket, uint32_t *statusCodePtr)</td></tr>
-<tr class="memdesc:ga0cad302f741f3f58a2fda54b67110a70"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the HTTP status code from HTTP request. <br /></td></tr>
+<tr class="memitem:ga0cad302f741f3f58a2fda54b67110a70"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__socket__http.html#ga0cad302f741f3f58a2fda54b67110a70">wiconnect::SocketInterface::httpGetStatus</a> (<a class="el" href="classwiconnect_1_1_socket.html">Socket</a> &amp;socket, uint32_t *statusCodePtr)</td></tr>
+<tr class="memdesc:ga0cad302f741f3f58a2fda54b67110a70"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the HTTP status code from HTTP request.  <a href="#ga0cad302f741f3f58a2fda54b67110a70">More...</a><br /></td></tr>
 <tr class="separator:ga0cad302f741f3f58a2fda54b67110a70"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
-<p>HTTP API methods. </p>
+<p>HTTP methods. </p>
+<h2 class="groupheader">Function Documentation</h2>
+<a class="anchor" id="ga2b3fd9a84f173312318e2bb22cef2004"></a>
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::SocketInterface::httpAddHeader </td>
+          <td>(</td>
+          <td class="paramtype"><a class="el" href="classwiconnect_1_1_socket.html">Socket</a> &amp;&#160;</td>
+          <td class="paramname"><em>socket</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">const char *&#160;</td>
+          <td class="paramname"><em>key</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">const char *&#160;</td>
+          <td class="paramname"><em>value</em>&#160;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Add HTTP header key/value pair to opened HTTP request. </p>
+<p>To use this function, the supplied <a class="el" href="classwiconnect_1_1_socket.html">Socket</a> parameter must have been created using either <a class="el" href="group__api__socket__http.html#ga818f9fc3d616deb5ac009f001e5e611b" title="Issue HTTP GET Request. ">httpGet()</a> or <a class="el" href="group__api__socket__http.html#gaaa5cb3c4b27ed0f2002e81392606a756" title="Issue HTTP POST Request. ">httpPost()</a> and the 'openOnly' parameter TRUE.</p>
+<p>This will add additional header to the HTTP request.</p>
+<p>Use <a class="el" href="group__api__socket__http.html#ga0cad302f741f3f58a2fda54b67110a70" title="Get the HTTP status code from HTTP request. ">httpGetStatus()</a> to issue the request.</p>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramdir">[in]</td><td class="paramname">socket</td><td>Opened socket to add additonal HTTP header </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">key</td><td>Header key (e.g. 'content-type') </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>Header value (e.g. 'application/json') </td></tr>
+  </table>
+  </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>Result of method. See <a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </dd></dl>
+
+</div>
+</div>
+<a class="anchor" id="gab2d562c96f8f40d916fc1df1229f0e09"></a>
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::SocketInterface::httpConnect </td>
+          <td>(</td>
+          <td class="paramtype"><a class="el" href="classwiconnect_1_1_socket.html">Socket</a> &amp;&#160;</td>
+          <td class="paramname"><em>socket</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">const char *&#160;</td>
+          <td class="paramname"><em>url</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">const <a class="el" href="structwiconnect_1_1_http_socket_args.html">HttpSocketArgs</a> *&#160;</td>
+          <td class="paramname"><em>args</em>&#160;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Connect to remote HTTP server. </p>
+<p>This is the base method for the other HTTP methods.</p>
+<h1><a class="anchor" id="secure_http_connection"></a>
+Secure HTTP</h1>
+<p>Each HTTP method is able to connect to a secure HTTP server. To do this, the URL string parameter must start with '<a href="https://'">https://'</a> To connect to a secure HTTP server a TLS certificate is needed. The certificate is specified in the certFilename parameter of the method (or <a class="el" href="structwiconnect_1_1_http_socket_args.html">HttpSocketArgs</a> parameter). This is the filename of an existing certificate on the module file system.</p>
+<dl class="section note"><dt>Note</dt><dd>If the URL starts with '<a href="https://'">https://'</a> and no certificate filename is specified, the module's default certificate is used.</dd></dl>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramdir">[out]</td><td class="paramname">socket</td><td>HTTP <a class="el" href="classwiconnect_1_1_socket.html">Socket</a> object of opened connection. </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">url</td><td>URL of HTTP request </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">args</td><td>Configuration <a class="el" href="structwiconnect_1_1_http_socket_args.html">HttpSocketArgs</a> for HTTP connection </td></tr>
+  </table>
+  </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>Result of method. See <a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </dd></dl>
+
+</div>
+</div>
+<a class="anchor" id="ga818f9fc3d616deb5ac009f001e5e611b"></a>
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::SocketInterface::httpGet </td>
+          <td>(</td>
+          <td class="paramtype"><a class="el" href="classwiconnect_1_1_socket.html">Socket</a> &amp;&#160;</td>
+          <td class="paramname"><em>socket</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">const char *&#160;</td>
+          <td class="paramname"><em>url</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">bool&#160;</td>
+          <td class="paramname"><em>openOnly</em> = <code>false</code>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">const char *&#160;</td>
+          <td class="paramname"><em>certFilename</em> = <code>NULL</code>&#160;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Issue HTTP GET Request. </p>
+<p>This method has the open to only 'open' the connection (disabled by default). This means a connection to the remote HTTP server is opened, but the HTTP request isn't issued. This allow for addition data to be added to the request. For instance, use <a class="el" href="group__api__socket__http.html#ga2b3fd9a84f173312318e2bb22cef2004" title="Add HTTP header key/value pair to opened HTTP request. ">httpAddHeader()</a> to add additional headers to the request. Use <a class="el" href="group__api__socket__http.html#ga0cad302f741f3f58a2fda54b67110a70" title="Get the HTTP status code from HTTP request. ">httpGetStatus()</a> to issue the HTTP request and receive the HTTP response.</p>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramdir">[out]</td><td class="paramname">socket</td><td>HTTP <a class="el" href="classwiconnect_1_1_socket.html">Socket</a> object of opened connection. </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">url</td><td>URL of HTTP GET request </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">openOnly</td><td>Optional, if TRUE this will only open a connection to the server (it won't issue the request) </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">certFilename</td><td>Optional, filename of existing TLS certificate on module's file system. See <a class="el" href="group__api__socket__http.html#secure_http_connection">Secure HTTP</a> </td></tr>
+  </table>
+  </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>Result of method. See <a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </dd></dl>
+
+</div>
+</div>
+<a class="anchor" id="ga0cad302f741f3f58a2fda54b67110a70"></a>
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::SocketInterface::httpGetStatus </td>
+          <td>(</td>
+          <td class="paramtype"><a class="el" href="classwiconnect_1_1_socket.html">Socket</a> &amp;&#160;</td>
+          <td class="paramname"><em>socket</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">uint32_t *&#160;</td>
+          <td class="paramname"><em>statusCodePtr</em>&#160;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Get the HTTP status code from HTTP request. </p>
+<p>This may be used to either issue an HTTP request of an opened HTTP connection or return the status code of a request already issued.</p>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramdir">[in]</td><td class="paramname">socket</td><td>Opened socket to get http response status code </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">statusCodePtr</td><td>Pointer to uint32 to hold http status code </td></tr>
+  </table>
+  </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>Result of method. See <a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </dd></dl>
+
+</div>
+</div>
+<a class="anchor" id="ga949cee4543c91951219652bd6282049f"></a>
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::SocketInterface::httpHead </td>
+          <td>(</td>
+          <td class="paramtype"><a class="el" href="classwiconnect_1_1_socket.html">Socket</a> &amp;&#160;</td>
+          <td class="paramname"><em>socket</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">const char *&#160;</td>
+          <td class="paramname"><em>url</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">const char *&#160;</td>
+          <td class="paramname"><em>certFilename</em> = <code>NULL</code>&#160;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Issue HTTP HEAD Request. </p>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramdir">[out]</td><td class="paramname">socket</td><td>HTTP <a class="el" href="classwiconnect_1_1_socket.html">Socket</a> object of opened connection. </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">url</td><td>URL of HTTP HEAD request </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">certFilename</td><td>Optional, filename of existing TLS certificate on module's file system. See <a class="el" href="group__api__socket__http.html#secure_http_connection">Secure HTTP</a> </td></tr>
+  </table>
+  </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>Result of method. See <a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </dd></dl>
+
+</div>
+</div>
+<a class="anchor" id="gaaa5cb3c4b27ed0f2002e81392606a756"></a>
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::SocketInterface::httpPost </td>
+          <td>(</td>
+          <td class="paramtype"><a class="el" href="classwiconnect_1_1_socket.html">Socket</a> &amp;&#160;</td>
+          <td class="paramname"><em>socket</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">const char *&#160;</td>
+          <td class="paramname"><em>url</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">const char *&#160;</td>
+          <td class="paramname"><em>contextType</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">bool&#160;</td>
+          <td class="paramname"><em>openOnly</em> = <code>true</code>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">const char *&#160;</td>
+          <td class="paramname"><em>certFilename</em> = <code>NULL</code>&#160;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Issue HTTP POST Request. </p>
+<p>This method has the open to only 'open' the connection which enabled by default. This means a connection to the remote HTTP server is opened, but the HTTP request isn't issued. This allow for addition data to be added to the request. Use the returned <a class="el" href="classwiconnect_1_1_socket.html">Socket</a> object's 'write' methods to add POST data to the request. When all POST data has been written, use <a class="el" href="group__api__socket__http.html#ga0cad302f741f3f58a2fda54b67110a70" title="Get the HTTP status code from HTTP request. ">httpGetStatus()</a> to issue the HTTP request and receive the HTTP response.</p>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramdir">[out]</td><td class="paramname">socket</td><td>HTTP <a class="el" href="classwiconnect_1_1_socket.html">Socket</a> object of opened connection. </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">url</td><td>URL of HTTP POST request </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">contextType</td><td>The value to go into the 'content-type' HTTP header (e.g. 'application/json') </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">openOnly</td><td>Optional, if FALSE this will immediately issue the POST request. </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">certFilename</td><td>Optional, filename of existing TLS certificate on module's file system. See <a class="el" href="group__api__socket__http.html#secure_http_connection">Secure HTTP</a> </td></tr>
+  </table>
+  </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>Result of method. See <a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </dd></dl>
+
+</div>
+</div>
 </div><!-- contents -->
 </div><!-- doc-content -->
-<!-- start footer part -->
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
-    <li class="footer">Generated on Tue Aug 12 2014 02:15:22 for WiConnect Library by
-    <a href="http://www.doxygen.org/index.html">
-    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.7 </li>
+    <li class="footer">&copy; ACKme Networks 2014</li>
   </ul>
 </div>
 </body>
-</html>
+</html>
\ No newline at end of file