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/mbed/html/group__api__socket__http.html

Revision:
34:2616445d0823
Child:
39:a963f69cb2de
diff -r b2bdbc018665 -r 2616445d0823 doc/mbed/html/group__api__socket__http.html
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/mbed/html/group__api__socket__http.html	Wed Nov 26 23:46:00 2014 -0800
@@ -0,0 +1,426 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
+<meta http-equiv="X-UA-Compatible" content="IE=9"/>
+<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>
+<link href="navtree.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="resize.js"></script>
+<script type="text/javascript" src="navtree.js"></script>
+<script type="text/javascript">
+  $(document).ready(initResizable);
+  $(window).load(resizeHeight);
+</script>
+<link href="search/search.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="search/search.js"></script>
+<script type="text/javascript">
+  $(document).ready(function() { searchBox.OnSelectItem(0); });
+</script>
+<link href="doxygen.css" rel="stylesheet" type="text/css" />
+</head>
+<body>
+<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
+<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>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/2.0/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><a href="http://developer.mbed.org/teams/ACKme/code/WiConnect/"><span>WiConnect&#160;Repository</span></a></li>
+      <li>
+        <div id="MSearchBox" class="MSearchBoxInactive">
+        <span class="left">
+          <img id="MSearchSelect" src="search/mag_sel.png"
+               onmouseover="return searchBox.OnSearchSelectShow()"
+               onmouseout="return searchBox.OnSearchSelectHide()"
+               alt=""/>
+          <input type="text" id="MSearchField" value="Search" accesskey="S"
+               onfocus="searchBox.OnSearchFieldFocus(true)" 
+               onblur="searchBox.OnSearchFieldFocus(false)" 
+               onkeyup="searchBox.OnSearchFieldChange(event)"/>
+          </span><span class="right">
+            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
+          </span>
+        </div>
+      </li>
+    </ul>
+  </div>
+</div><!-- top -->
+<div id="side-nav" class="ui-resizable side-nav-resizable">
+  <div id="nav-tree">
+    <div id="nav-tree-contents">
+      <div id="nav-sync" class="sync"></div>
+    </div>
+  </div>
+  <div id="splitbar" style="-moz-user-select:none;" 
+       class="ui-resizable-handle">
+  </div>
+</div>
+<script type="text/javascript">
+$(document).ready(function(){initNavTree('group__api__socket__http.html','');});
+</script>
+<div id="doc-content">
+<!-- window showing the filter options -->
+<div id="MSearchSelectWindow"
+     onmouseover="return searchBox.OnSearchSelectShow()"
+     onmouseout="return searchBox.OnSearchSelectHide()"
+     onkeydown="return searchBox.OnSearchSelectKey(event)">
+<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Pages</a></div>
+
+<!-- iframe showing the search results (closed by default) -->
+<div id="MSearchResultsWindow">
+<iframe src="javascript:void(0)" frameborder="0" 
+        name="MSearchResults" id="MSearchResults">
+</iframe>
+</div>
+
+<div class="header">
+  <div class="summary">
+<a href="#func-members">Functions</a>  </div>
+  <div class="headertitle">
+<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 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:ga181a03d883f60dff0c03b65e066f0eed"><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#ga181a03d883f60dff0c03b65e066f0eed">wiconnect::SocketInterface::httpConnect</a> (<a class="el" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</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:ga181a03d883f60dff0c03b65e066f0eed"><td class="mdescLeft">&#160;</td><td class="mdescRight">Connect to remote HTTP server.  <a href="#ga181a03d883f60dff0c03b65e066f0eed">More...</a><br /></td></tr>
+<tr class="separator:ga181a03d883f60dff0c03b65e066f0eed"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:gac9b6c6a348f790cc8d43889dd72029f6"><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#gac9b6c6a348f790cc8d43889dd72029f6">wiconnect::SocketInterface::httpGet</a> (<a class="el" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> &amp;socket, const char *url, bool openOnly=false, const char *certFilename=NULL)</td></tr>
+<tr class="memdesc:gac9b6c6a348f790cc8d43889dd72029f6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Issue HTTP GET Request.  <a href="#gac9b6c6a348f790cc8d43889dd72029f6">More...</a><br /></td></tr>
+<tr class="separator:gac9b6c6a348f790cc8d43889dd72029f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga1b6a3ebdbd164f0eb683fc335ef4d365"><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#ga1b6a3ebdbd164f0eb683fc335ef4d365">wiconnect::SocketInterface::httpPost</a> (<a class="el" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> &amp;socket, const char *url, const char *contextType, bool openOnly=true, const char *certFilename=NULL)</td></tr>
+<tr class="memdesc:ga1b6a3ebdbd164f0eb683fc335ef4d365"><td class="mdescLeft">&#160;</td><td class="mdescRight">Issue HTTP POST Request.  <a href="#ga1b6a3ebdbd164f0eb683fc335ef4d365">More...</a><br /></td></tr>
+<tr class="separator:ga1b6a3ebdbd164f0eb683fc335ef4d365"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:gabcb3d69b2b1718e7ebe1ed171dec1f85"><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#gabcb3d69b2b1718e7ebe1ed171dec1f85">wiconnect::SocketInterface::httpHead</a> (<a class="el" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> &amp;socket, const char *url, const char *certFilename=NULL)</td></tr>
+<tr class="memdesc:gabcb3d69b2b1718e7ebe1ed171dec1f85"><td class="mdescLeft">&#160;</td><td class="mdescRight">Issue HTTP HEAD Request.  <a href="#gabcb3d69b2b1718e7ebe1ed171dec1f85">More...</a><br /></td></tr>
+<tr class="separator:gabcb3d69b2b1718e7ebe1ed171dec1f85"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:gabed18edc44f464bac64ce8a6dc3617ec"><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#gabed18edc44f464bac64ce8a6dc3617ec">wiconnect::SocketInterface::httpAddHeader</a> (<a class="el" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> &amp;socket, const char *key, const char *value)</td></tr>
+<tr class="memdesc:gabed18edc44f464bac64ce8a6dc3617ec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add HTTP header key/value pair to opened HTTP request.  <a href="#gabed18edc44f464bac64ce8a6dc3617ec">More...</a><br /></td></tr>
+<tr class="separator:gabed18edc44f464bac64ce8a6dc3617ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:gadf59ca0783b89ee32f205e33f1bd5517"><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#gadf59ca0783b89ee32f205e33f1bd5517">wiconnect::SocketInterface::httpGetStatus</a> (<a class="el" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> &amp;socket, uint32_t *statusCodePtr)</td></tr>
+<tr class="memdesc:gadf59ca0783b89ee32f205e33f1bd5517"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the HTTP status code from HTTP request.  <a href="#gadf59ca0783b89ee32f205e33f1bd5517">More...</a><br /></td></tr>
+<tr class="separator:gadf59ca0783b89ee32f205e33f1bd5517"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table>
+<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
+<p>HTTP methods. </p>
+<h2 class="groupheader">Function Documentation</h2>
+<a class="anchor" id="gabed18edc44f464bac64ce8a6dc3617ec"></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_wiconnect_socket.html">WiconnectSocket</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_wiconnect_socket.html">WiconnectSocket</a> parameter must have been created using either <a class="el" href="group__api__socket__http.html#gac9b6c6a348f790cc8d43889dd72029f6" title="Issue HTTP GET Request. ">httpGet()</a> or <a class="el" href="group__api__socket__http.html#ga1b6a3ebdbd164f0eb683fc335ef4d365" 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#gadf59ca0783b89ee32f205e33f1bd5517" 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="ga181a03d883f60dff0c03b65e066f0eed"></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_wiconnect_socket.html">WiconnectSocket</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_wiconnect_socket.html">WiconnectSocket</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="gac9b6c6a348f790cc8d43889dd72029f6"></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_wiconnect_socket.html">WiconnectSocket</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#gabed18edc44f464bac64ce8a6dc3617ec" 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#gadf59ca0783b89ee32f205e33f1bd5517" 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_wiconnect_socket.html">WiconnectSocket</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="gadf59ca0783b89ee32f205e33f1bd5517"></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_wiconnect_socket.html">WiconnectSocket</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="gabcb3d69b2b1718e7ebe1ed171dec1f85"></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_wiconnect_socket.html">WiconnectSocket</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_wiconnect_socket.html">WiconnectSocket</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="ga1b6a3ebdbd164f0eb683fc335ef4d365"></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_wiconnect_socket.html">WiconnectSocket</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_wiconnect_socket.html">WiconnectSocket</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#gadf59ca0783b89ee32f205e33f1bd5517" 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_wiconnect_socket.html">WiconnectSocket</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 -->
+<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
+  <ul>
+    <li class="footer">&copy; ACKme Networks 2014</li>
+  </ul>
+</div>
+</body>
+</html>
\ No newline at end of file