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

doc/mbed/html/group__api__socket__http.html@34:2616445d0823, 2014-11-26 (annotated)

Committer:
dan_ackme
Date:
Wed Nov 26 23:46:00 2014 -0800
Revision:
34:2616445d0823
Child:
39:a963f69cb2de
added support for out-dated wifi firmware

Who changed what in which revision?

UserRevisionLine numberNew contents of line
dan_ackme 34:2616445d0823 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
dan_ackme 34:2616445d0823 2 <html xmlns="http://www.w3.org/1999/xhtml">
dan_ackme 34:2616445d0823 3 <head>
dan_ackme 34:2616445d0823 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
dan_ackme 34:2616445d0823 5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
dan_ackme 34:2616445d0823 6 <title>ACKme WiConnect Host Library</title>
dan_ackme 34:2616445d0823 7 <link rel="icon" href="favicon.ico" type="image/x-icon">
dan_ackme 34:2616445d0823 8 <link rel="shortcut icon" href="favicon.ico" type="image/x-icon">
dan_ackme 34:2616445d0823 9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
dan_ackme 34:2616445d0823 10 <script type="text/javascript" src="jquery.js"></script>
dan_ackme 34:2616445d0823 11 <script type="text/javascript" src="dynsections.js"></script>
dan_ackme 34:2616445d0823 12 <link href="navtree.css" rel="stylesheet" type="text/css"/>
dan_ackme 34:2616445d0823 13 <script type="text/javascript" src="resize.js"></script>
dan_ackme 34:2616445d0823 14 <script type="text/javascript" src="navtree.js"></script>
dan_ackme 34:2616445d0823 15 <script type="text/javascript">
dan_ackme 34:2616445d0823 16 $(document).ready(initResizable);
dan_ackme 34:2616445d0823 17 $(window).load(resizeHeight);
dan_ackme 34:2616445d0823 18 </script>
dan_ackme 34:2616445d0823 19 <link href="search/search.css" rel="stylesheet" type="text/css"/>
dan_ackme 34:2616445d0823 20 <script type="text/javascript" src="search/search.js"></script>
dan_ackme 34:2616445d0823 21 <script type="text/javascript">
dan_ackme 34:2616445d0823 22 $(document).ready(function() { searchBox.OnSelectItem(0); });
dan_ackme 34:2616445d0823 23 </script>
dan_ackme 34:2616445d0823 24 <link href="doxygen.css" rel="stylesheet" type="text/css" />
dan_ackme 34:2616445d0823 25 </head>
dan_ackme 34:2616445d0823 26 <body>
dan_ackme 34:2616445d0823 27 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
dan_ackme 34:2616445d0823 28 <div id="titlearea" style="font-family:verdana;">
dan_ackme 34:2616445d0823 29 <table border='0' cellpadding='0' cellspacing='0' width="98%">
dan_ackme 34:2616445d0823 30 <tr style="height:20px"><td>&nbsp;</td></tr>
dan_ackme 34:2616445d0823 31 <tr style="border-collapse: collapse; padding: 0;">
dan_ackme 34:2616445d0823 32 <td style="width:20px"></td>
dan_ackme 34:2616445d0823 33 <td style="padding-right:40px"><img src="ackmelogo.png" alt="ACKme Logo" /></td>
dan_ackme 34:2616445d0823 34 <td style="vertical-align:middle; text-align:left; font: bold 25px/100% Verdana, Arial, Helvetica, sans-serif;">
dan_ackme 34:2616445d0823 35 WiConnect Host Library- API Reference Guide</td>
dan_ackme 34:2616445d0823 36 <td style="width:20px"></td>
dan_ackme 34:2616445d0823 37 </tr>
dan_ackme 34:2616445d0823 38 <tr><td>&nbsp;</td></tr>
dan_ackme 34:2616445d0823 39 </table>
dan_ackme 34:2616445d0823 40 </div><!-- Generated by Doxygen 1.8.7 -->
dan_ackme 34:2616445d0823 41 <script type="text/javascript">
dan_ackme 34:2616445d0823 42 var searchBox = new SearchBox("searchBox", "search",false,'Search');
dan_ackme 34:2616445d0823 43 </script>
dan_ackme 34:2616445d0823 44 <div id="navrow1" class="tabs">
dan_ackme 34:2616445d0823 45 <ul class="tablist">
dan_ackme 34:2616445d0823 46 <li><a href="index.html"><span>Library&#160;Overview</span></a></li>
dan_ackme 34:2616445d0823 47 <li><a href="modules.html"><span>Library&#160;API</span></a></li>
dan_ackme 34:2616445d0823 48 <li><a href="examples.html"><span>API&#160;Examples</span></a></li>
dan_ackme 34:2616445d0823 49 <li><a href="annotated.html"><span>Classes</span></a></li>
dan_ackme 34:2616445d0823 50 <li><a href="http://wiconnect.ack.me/2.0/general_overview"><span>WiConnect&#160;Reference&#160;Manual</span></a></li>
dan_ackme 34:2616445d0823 51 <li><a href="http://www.ack.me/WiConnect"><span>ACKme&#160;Website</span></a></li>
dan_ackme 34:2616445d0823 52 <li><a href="http://developer.mbed.org/teams/ACKme/code/WiConnect/"><span>WiConnect&#160;Repository</span></a></li>
dan_ackme 34:2616445d0823 53 <li>
dan_ackme 34:2616445d0823 54 <div id="MSearchBox" class="MSearchBoxInactive">
dan_ackme 34:2616445d0823 55 <span class="left">
dan_ackme 34:2616445d0823 56 <img id="MSearchSelect" src="search/mag_sel.png"
dan_ackme 34:2616445d0823 57 onmouseover="return searchBox.OnSearchSelectShow()"
dan_ackme 34:2616445d0823 58 onmouseout="return searchBox.OnSearchSelectHide()"
dan_ackme 34:2616445d0823 59 alt=""/>
dan_ackme 34:2616445d0823 60 <input type="text" id="MSearchField" value="Search" accesskey="S"
dan_ackme 34:2616445d0823 61 onfocus="searchBox.OnSearchFieldFocus(true)"
dan_ackme 34:2616445d0823 62 onblur="searchBox.OnSearchFieldFocus(false)"
dan_ackme 34:2616445d0823 63 onkeyup="searchBox.OnSearchFieldChange(event)"/>
dan_ackme 34:2616445d0823 64 </span><span class="right">
dan_ackme 34:2616445d0823 65 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
dan_ackme 34:2616445d0823 66 </span>
dan_ackme 34:2616445d0823 67 </div>
dan_ackme 34:2616445d0823 68 </li>
dan_ackme 34:2616445d0823 69 </ul>
dan_ackme 34:2616445d0823 70 </div>
dan_ackme 34:2616445d0823 71 </div><!-- top -->
dan_ackme 34:2616445d0823 72 <div id="side-nav" class="ui-resizable side-nav-resizable">
dan_ackme 34:2616445d0823 73 <div id="nav-tree">
dan_ackme 34:2616445d0823 74 <div id="nav-tree-contents">
dan_ackme 34:2616445d0823 75 <div id="nav-sync" class="sync"></div>
dan_ackme 34:2616445d0823 76 </div>
dan_ackme 34:2616445d0823 77 </div>
dan_ackme 34:2616445d0823 78 <div id="splitbar" style="-moz-user-select:none;"
dan_ackme 34:2616445d0823 79 class="ui-resizable-handle">
dan_ackme 34:2616445d0823 80 </div>
dan_ackme 34:2616445d0823 81 </div>
dan_ackme 34:2616445d0823 82 <script type="text/javascript">
dan_ackme 34:2616445d0823 83 $(document).ready(function(){initNavTree('group__api__socket__http.html','');});
dan_ackme 34:2616445d0823 84 </script>
dan_ackme 34:2616445d0823 85 <div id="doc-content">
dan_ackme 34:2616445d0823 86 <!-- window showing the filter options -->
dan_ackme 34:2616445d0823 87 <div id="MSearchSelectWindow"
dan_ackme 34:2616445d0823 88 onmouseover="return searchBox.OnSearchSelectShow()"
dan_ackme 34:2616445d0823 89 onmouseout="return searchBox.OnSearchSelectHide()"
dan_ackme 34:2616445d0823 90 onkeydown="return searchBox.OnSearchSelectKey(event)">
dan_ackme 34:2616445d0823 91 <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>
dan_ackme 34:2616445d0823 92
dan_ackme 34:2616445d0823 93 <!-- iframe showing the search results (closed by default) -->
dan_ackme 34:2616445d0823 94 <div id="MSearchResultsWindow">
dan_ackme 34:2616445d0823 95 <iframe src="javascript:void(0)" frameborder="0"
dan_ackme 34:2616445d0823 96 name="MSearchResults" id="MSearchResults">
dan_ackme 34:2616445d0823 97 </iframe>
dan_ackme 34:2616445d0823 98 </div>
dan_ackme 34:2616445d0823 99
dan_ackme 34:2616445d0823 100 <div class="header">
dan_ackme 34:2616445d0823 101 <div class="summary">
dan_ackme 34:2616445d0823 102 <a href="#func-members">Functions</a> </div>
dan_ackme 34:2616445d0823 103 <div class="headertitle">
dan_ackme 34:2616445d0823 104 <div class="title">HTTP Methods<div class="ingroups"><a class="el" href="group__api__socket.html">Socket</a></div></div> </div>
dan_ackme 34:2616445d0823 105 </div><!--header-->
dan_ackme 34:2616445d0823 106 <div class="contents">
dan_ackme 34:2616445d0823 107
dan_ackme 34:2616445d0823 108 <p>HTTP methods.
dan_ackme 34:2616445d0823 109 <a href="#details">More...</a></p>
dan_ackme 34:2616445d0823 110 <table class="memberdecls">
dan_ackme 34:2616445d0823 111 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
dan_ackme 34:2616445d0823 112 Functions</h2></td></tr>
dan_ackme 34:2616445d0823 113 <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>
dan_ackme 34:2616445d0823 114 <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>
dan_ackme 34:2616445d0823 115 <tr class="separator:ga181a03d883f60dff0c03b65e066f0eed"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 34:2616445d0823 116 <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>
dan_ackme 34:2616445d0823 117 <tr class="memdesc:gac9b6c6a348f790cc8d43889dd72029f6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Issue HTTP GET Request. <a href="#gac9b6c6a348f790cc8d43889dd72029f6">More...</a><br /></td></tr>
dan_ackme 34:2616445d0823 118 <tr class="separator:gac9b6c6a348f790cc8d43889dd72029f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 34:2616445d0823 119 <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>
dan_ackme 34:2616445d0823 120 <tr class="memdesc:ga1b6a3ebdbd164f0eb683fc335ef4d365"><td class="mdescLeft">&#160;</td><td class="mdescRight">Issue HTTP POST Request. <a href="#ga1b6a3ebdbd164f0eb683fc335ef4d365">More...</a><br /></td></tr>
dan_ackme 34:2616445d0823 121 <tr class="separator:ga1b6a3ebdbd164f0eb683fc335ef4d365"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 34:2616445d0823 122 <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>
dan_ackme 34:2616445d0823 123 <tr class="memdesc:gabcb3d69b2b1718e7ebe1ed171dec1f85"><td class="mdescLeft">&#160;</td><td class="mdescRight">Issue HTTP HEAD Request. <a href="#gabcb3d69b2b1718e7ebe1ed171dec1f85">More...</a><br /></td></tr>
dan_ackme 34:2616445d0823 124 <tr class="separator:gabcb3d69b2b1718e7ebe1ed171dec1f85"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 34:2616445d0823 125 <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>
dan_ackme 34:2616445d0823 126 <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>
dan_ackme 34:2616445d0823 127 <tr class="separator:gabed18edc44f464bac64ce8a6dc3617ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 34:2616445d0823 128 <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>
dan_ackme 34:2616445d0823 129 <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>
dan_ackme 34:2616445d0823 130 <tr class="separator:gadf59ca0783b89ee32f205e33f1bd5517"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 34:2616445d0823 131 </table>
dan_ackme 34:2616445d0823 132 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
dan_ackme 34:2616445d0823 133 <p>HTTP methods. </p>
dan_ackme 34:2616445d0823 134 <h2 class="groupheader">Function Documentation</h2>
dan_ackme 34:2616445d0823 135 <a class="anchor" id="gabed18edc44f464bac64ce8a6dc3617ec"></a>
dan_ackme 34:2616445d0823 136 <div class="memitem">
dan_ackme 34:2616445d0823 137 <div class="memproto">
dan_ackme 34:2616445d0823 138 <table class="memname">
dan_ackme 34:2616445d0823 139 <tr>
dan_ackme 34:2616445d0823 140 <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::SocketInterface::httpAddHeader </td>
dan_ackme 34:2616445d0823 141 <td>(</td>
dan_ackme 34:2616445d0823 142 <td class="paramtype"><a class="el" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> &amp;&#160;</td>
dan_ackme 34:2616445d0823 143 <td class="paramname"><em>socket</em>, </td>
dan_ackme 34:2616445d0823 144 </tr>
dan_ackme 34:2616445d0823 145 <tr>
dan_ackme 34:2616445d0823 146 <td class="paramkey"></td>
dan_ackme 34:2616445d0823 147 <td></td>
dan_ackme 34:2616445d0823 148 <td class="paramtype">const char *&#160;</td>
dan_ackme 34:2616445d0823 149 <td class="paramname"><em>key</em>, </td>
dan_ackme 34:2616445d0823 150 </tr>
dan_ackme 34:2616445d0823 151 <tr>
dan_ackme 34:2616445d0823 152 <td class="paramkey"></td>
dan_ackme 34:2616445d0823 153 <td></td>
dan_ackme 34:2616445d0823 154 <td class="paramtype">const char *&#160;</td>
dan_ackme 34:2616445d0823 155 <td class="paramname"><em>value</em>&#160;</td>
dan_ackme 34:2616445d0823 156 </tr>
dan_ackme 34:2616445d0823 157 <tr>
dan_ackme 34:2616445d0823 158 <td></td>
dan_ackme 34:2616445d0823 159 <td>)</td>
dan_ackme 34:2616445d0823 160 <td></td><td></td>
dan_ackme 34:2616445d0823 161 </tr>
dan_ackme 34:2616445d0823 162 </table>
dan_ackme 34:2616445d0823 163 </div><div class="memdoc">
dan_ackme 34:2616445d0823 164
dan_ackme 34:2616445d0823 165 <p>Add HTTP header key/value pair to opened HTTP request. </p>
dan_ackme 34:2616445d0823 166 <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>
dan_ackme 34:2616445d0823 167 <p>This will add additional header to the HTTP request.</p>
dan_ackme 34:2616445d0823 168 <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>
dan_ackme 34:2616445d0823 169 <dl class="params"><dt>Parameters</dt><dd>
dan_ackme 34:2616445d0823 170 <table class="params">
dan_ackme 34:2616445d0823 171 <tr><td class="paramdir">[in]</td><td class="paramname">socket</td><td>Opened socket to add additonal HTTP header </td></tr>
dan_ackme 34:2616445d0823 172 <tr><td class="paramdir">[in]</td><td class="paramname">key</td><td>Header key (e.g. 'content-type') </td></tr>
dan_ackme 34:2616445d0823 173 <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>Header value (e.g. 'application/json') </td></tr>
dan_ackme 34:2616445d0823 174 </table>
dan_ackme 34:2616445d0823 175 </dd>
dan_ackme 34:2616445d0823 176 </dl>
dan_ackme 34:2616445d0823 177 <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>
dan_ackme 34:2616445d0823 178
dan_ackme 34:2616445d0823 179 </div>
dan_ackme 34:2616445d0823 180 </div>
dan_ackme 34:2616445d0823 181 <a class="anchor" id="ga181a03d883f60dff0c03b65e066f0eed"></a>
dan_ackme 34:2616445d0823 182 <div class="memitem">
dan_ackme 34:2616445d0823 183 <div class="memproto">
dan_ackme 34:2616445d0823 184 <table class="memname">
dan_ackme 34:2616445d0823 185 <tr>
dan_ackme 34:2616445d0823 186 <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::SocketInterface::httpConnect </td>
dan_ackme 34:2616445d0823 187 <td>(</td>
dan_ackme 34:2616445d0823 188 <td class="paramtype"><a class="el" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> &amp;&#160;</td>
dan_ackme 34:2616445d0823 189 <td class="paramname"><em>socket</em>, </td>
dan_ackme 34:2616445d0823 190 </tr>
dan_ackme 34:2616445d0823 191 <tr>
dan_ackme 34:2616445d0823 192 <td class="paramkey"></td>
dan_ackme 34:2616445d0823 193 <td></td>
dan_ackme 34:2616445d0823 194 <td class="paramtype">const char *&#160;</td>
dan_ackme 34:2616445d0823 195 <td class="paramname"><em>url</em>, </td>
dan_ackme 34:2616445d0823 196 </tr>
dan_ackme 34:2616445d0823 197 <tr>
dan_ackme 34:2616445d0823 198 <td class="paramkey"></td>
dan_ackme 34:2616445d0823 199 <td></td>
dan_ackme 34:2616445d0823 200 <td class="paramtype">const <a class="el" href="structwiconnect_1_1_http_socket_args.html">HttpSocketArgs</a> *&#160;</td>
dan_ackme 34:2616445d0823 201 <td class="paramname"><em>args</em>&#160;</td>
dan_ackme 34:2616445d0823 202 </tr>
dan_ackme 34:2616445d0823 203 <tr>
dan_ackme 34:2616445d0823 204 <td></td>
dan_ackme 34:2616445d0823 205 <td>)</td>
dan_ackme 34:2616445d0823 206 <td></td><td></td>
dan_ackme 34:2616445d0823 207 </tr>
dan_ackme 34:2616445d0823 208 </table>
dan_ackme 34:2616445d0823 209 </div><div class="memdoc">
dan_ackme 34:2616445d0823 210
dan_ackme 34:2616445d0823 211 <p>Connect to remote HTTP server. </p>
dan_ackme 34:2616445d0823 212 <p>This is the base method for the other HTTP methods.</p>
dan_ackme 34:2616445d0823 213 <h1><a class="anchor" id="secure_http_connection"></a>
dan_ackme 34:2616445d0823 214 Secure HTTP</h1>
dan_ackme 34:2616445d0823 215 <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>
dan_ackme 34:2616445d0823 216 <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>
dan_ackme 34:2616445d0823 217 <dl class="params"><dt>Parameters</dt><dd>
dan_ackme 34:2616445d0823 218 <table class="params">
dan_ackme 34:2616445d0823 219 <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>
dan_ackme 34:2616445d0823 220 <tr><td class="paramdir">[in]</td><td class="paramname">url</td><td>URL of HTTP request </td></tr>
dan_ackme 34:2616445d0823 221 <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>
dan_ackme 34:2616445d0823 222 </table>
dan_ackme 34:2616445d0823 223 </dd>
dan_ackme 34:2616445d0823 224 </dl>
dan_ackme 34:2616445d0823 225 <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>
dan_ackme 34:2616445d0823 226
dan_ackme 34:2616445d0823 227 </div>
dan_ackme 34:2616445d0823 228 </div>
dan_ackme 34:2616445d0823 229 <a class="anchor" id="gac9b6c6a348f790cc8d43889dd72029f6"></a>
dan_ackme 34:2616445d0823 230 <div class="memitem">
dan_ackme 34:2616445d0823 231 <div class="memproto">
dan_ackme 34:2616445d0823 232 <table class="memname">
dan_ackme 34:2616445d0823 233 <tr>
dan_ackme 34:2616445d0823 234 <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::SocketInterface::httpGet </td>
dan_ackme 34:2616445d0823 235 <td>(</td>
dan_ackme 34:2616445d0823 236 <td class="paramtype"><a class="el" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> &amp;&#160;</td>
dan_ackme 34:2616445d0823 237 <td class="paramname"><em>socket</em>, </td>
dan_ackme 34:2616445d0823 238 </tr>
dan_ackme 34:2616445d0823 239 <tr>
dan_ackme 34:2616445d0823 240 <td class="paramkey"></td>
dan_ackme 34:2616445d0823 241 <td></td>
dan_ackme 34:2616445d0823 242 <td class="paramtype">const char *&#160;</td>
dan_ackme 34:2616445d0823 243 <td class="paramname"><em>url</em>, </td>
dan_ackme 34:2616445d0823 244 </tr>
dan_ackme 34:2616445d0823 245 <tr>
dan_ackme 34:2616445d0823 246 <td class="paramkey"></td>
dan_ackme 34:2616445d0823 247 <td></td>
dan_ackme 34:2616445d0823 248 <td class="paramtype">bool&#160;</td>
dan_ackme 34:2616445d0823 249 <td class="paramname"><em>openOnly</em> = <code>false</code>, </td>
dan_ackme 34:2616445d0823 250 </tr>
dan_ackme 34:2616445d0823 251 <tr>
dan_ackme 34:2616445d0823 252 <td class="paramkey"></td>
dan_ackme 34:2616445d0823 253 <td></td>
dan_ackme 34:2616445d0823 254 <td class="paramtype">const char *&#160;</td>
dan_ackme 34:2616445d0823 255 <td class="paramname"><em>certFilename</em> = <code>NULL</code>&#160;</td>
dan_ackme 34:2616445d0823 256 </tr>
dan_ackme 34:2616445d0823 257 <tr>
dan_ackme 34:2616445d0823 258 <td></td>
dan_ackme 34:2616445d0823 259 <td>)</td>
dan_ackme 34:2616445d0823 260 <td></td><td></td>
dan_ackme 34:2616445d0823 261 </tr>
dan_ackme 34:2616445d0823 262 </table>
dan_ackme 34:2616445d0823 263 </div><div class="memdoc">
dan_ackme 34:2616445d0823 264
dan_ackme 34:2616445d0823 265 <p>Issue HTTP GET Request. </p>
dan_ackme 34:2616445d0823 266 <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>
dan_ackme 34:2616445d0823 267 <dl class="params"><dt>Parameters</dt><dd>
dan_ackme 34:2616445d0823 268 <table class="params">
dan_ackme 34:2616445d0823 269 <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>
dan_ackme 34:2616445d0823 270 <tr><td class="paramdir">[in]</td><td class="paramname">url</td><td>URL of HTTP GET request </td></tr>
dan_ackme 34:2616445d0823 271 <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>
dan_ackme 34:2616445d0823 272 <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>
dan_ackme 34:2616445d0823 273 </table>
dan_ackme 34:2616445d0823 274 </dd>
dan_ackme 34:2616445d0823 275 </dl>
dan_ackme 34:2616445d0823 276 <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>
dan_ackme 34:2616445d0823 277
dan_ackme 34:2616445d0823 278 </div>
dan_ackme 34:2616445d0823 279 </div>
dan_ackme 34:2616445d0823 280 <a class="anchor" id="gadf59ca0783b89ee32f205e33f1bd5517"></a>
dan_ackme 34:2616445d0823 281 <div class="memitem">
dan_ackme 34:2616445d0823 282 <div class="memproto">
dan_ackme 34:2616445d0823 283 <table class="memname">
dan_ackme 34:2616445d0823 284 <tr>
dan_ackme 34:2616445d0823 285 <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::SocketInterface::httpGetStatus </td>
dan_ackme 34:2616445d0823 286 <td>(</td>
dan_ackme 34:2616445d0823 287 <td class="paramtype"><a class="el" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> &amp;&#160;</td>
dan_ackme 34:2616445d0823 288 <td class="paramname"><em>socket</em>, </td>
dan_ackme 34:2616445d0823 289 </tr>
dan_ackme 34:2616445d0823 290 <tr>
dan_ackme 34:2616445d0823 291 <td class="paramkey"></td>
dan_ackme 34:2616445d0823 292 <td></td>
dan_ackme 34:2616445d0823 293 <td class="paramtype">uint32_t *&#160;</td>
dan_ackme 34:2616445d0823 294 <td class="paramname"><em>statusCodePtr</em>&#160;</td>
dan_ackme 34:2616445d0823 295 </tr>
dan_ackme 34:2616445d0823 296 <tr>
dan_ackme 34:2616445d0823 297 <td></td>
dan_ackme 34:2616445d0823 298 <td>)</td>
dan_ackme 34:2616445d0823 299 <td></td><td></td>
dan_ackme 34:2616445d0823 300 </tr>
dan_ackme 34:2616445d0823 301 </table>
dan_ackme 34:2616445d0823 302 </div><div class="memdoc">
dan_ackme 34:2616445d0823 303
dan_ackme 34:2616445d0823 304 <p>Get the HTTP status code from HTTP request. </p>
dan_ackme 34:2616445d0823 305 <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>
dan_ackme 34:2616445d0823 306 <dl class="params"><dt>Parameters</dt><dd>
dan_ackme 34:2616445d0823 307 <table class="params">
dan_ackme 34:2616445d0823 308 <tr><td class="paramdir">[in]</td><td class="paramname">socket</td><td>Opened socket to get http response status code </td></tr>
dan_ackme 34:2616445d0823 309 <tr><td class="paramdir">[out]</td><td class="paramname">statusCodePtr</td><td>Pointer to uint32 to hold http status code </td></tr>
dan_ackme 34:2616445d0823 310 </table>
dan_ackme 34:2616445d0823 311 </dd>
dan_ackme 34:2616445d0823 312 </dl>
dan_ackme 34:2616445d0823 313 <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>
dan_ackme 34:2616445d0823 314
dan_ackme 34:2616445d0823 315 </div>
dan_ackme 34:2616445d0823 316 </div>
dan_ackme 34:2616445d0823 317 <a class="anchor" id="gabcb3d69b2b1718e7ebe1ed171dec1f85"></a>
dan_ackme 34:2616445d0823 318 <div class="memitem">
dan_ackme 34:2616445d0823 319 <div class="memproto">
dan_ackme 34:2616445d0823 320 <table class="memname">
dan_ackme 34:2616445d0823 321 <tr>
dan_ackme 34:2616445d0823 322 <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::SocketInterface::httpHead </td>
dan_ackme 34:2616445d0823 323 <td>(</td>
dan_ackme 34:2616445d0823 324 <td class="paramtype"><a class="el" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> &amp;&#160;</td>
dan_ackme 34:2616445d0823 325 <td class="paramname"><em>socket</em>, </td>
dan_ackme 34:2616445d0823 326 </tr>
dan_ackme 34:2616445d0823 327 <tr>
dan_ackme 34:2616445d0823 328 <td class="paramkey"></td>
dan_ackme 34:2616445d0823 329 <td></td>
dan_ackme 34:2616445d0823 330 <td class="paramtype">const char *&#160;</td>
dan_ackme 34:2616445d0823 331 <td class="paramname"><em>url</em>, </td>
dan_ackme 34:2616445d0823 332 </tr>
dan_ackme 34:2616445d0823 333 <tr>
dan_ackme 34:2616445d0823 334 <td class="paramkey"></td>
dan_ackme 34:2616445d0823 335 <td></td>
dan_ackme 34:2616445d0823 336 <td class="paramtype">const char *&#160;</td>
dan_ackme 34:2616445d0823 337 <td class="paramname"><em>certFilename</em> = <code>NULL</code>&#160;</td>
dan_ackme 34:2616445d0823 338 </tr>
dan_ackme 34:2616445d0823 339 <tr>
dan_ackme 34:2616445d0823 340 <td></td>
dan_ackme 34:2616445d0823 341 <td>)</td>
dan_ackme 34:2616445d0823 342 <td></td><td></td>
dan_ackme 34:2616445d0823 343 </tr>
dan_ackme 34:2616445d0823 344 </table>
dan_ackme 34:2616445d0823 345 </div><div class="memdoc">
dan_ackme 34:2616445d0823 346
dan_ackme 34:2616445d0823 347 <p>Issue HTTP HEAD Request. </p>
dan_ackme 34:2616445d0823 348 <dl class="params"><dt>Parameters</dt><dd>
dan_ackme 34:2616445d0823 349 <table class="params">
dan_ackme 34:2616445d0823 350 <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>
dan_ackme 34:2616445d0823 351 <tr><td class="paramdir">[in]</td><td class="paramname">url</td><td>URL of HTTP HEAD request </td></tr>
dan_ackme 34:2616445d0823 352 <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>
dan_ackme 34:2616445d0823 353 </table>
dan_ackme 34:2616445d0823 354 </dd>
dan_ackme 34:2616445d0823 355 </dl>
dan_ackme 34:2616445d0823 356 <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>
dan_ackme 34:2616445d0823 357
dan_ackme 34:2616445d0823 358 </div>
dan_ackme 34:2616445d0823 359 </div>
dan_ackme 34:2616445d0823 360 <a class="anchor" id="ga1b6a3ebdbd164f0eb683fc335ef4d365"></a>
dan_ackme 34:2616445d0823 361 <div class="memitem">
dan_ackme 34:2616445d0823 362 <div class="memproto">
dan_ackme 34:2616445d0823 363 <table class="memname">
dan_ackme 34:2616445d0823 364 <tr>
dan_ackme 34:2616445d0823 365 <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::SocketInterface::httpPost </td>
dan_ackme 34:2616445d0823 366 <td>(</td>
dan_ackme 34:2616445d0823 367 <td class="paramtype"><a class="el" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> &amp;&#160;</td>
dan_ackme 34:2616445d0823 368 <td class="paramname"><em>socket</em>, </td>
dan_ackme 34:2616445d0823 369 </tr>
dan_ackme 34:2616445d0823 370 <tr>
dan_ackme 34:2616445d0823 371 <td class="paramkey"></td>
dan_ackme 34:2616445d0823 372 <td></td>
dan_ackme 34:2616445d0823 373 <td class="paramtype">const char *&#160;</td>
dan_ackme 34:2616445d0823 374 <td class="paramname"><em>url</em>, </td>
dan_ackme 34:2616445d0823 375 </tr>
dan_ackme 34:2616445d0823 376 <tr>
dan_ackme 34:2616445d0823 377 <td class="paramkey"></td>
dan_ackme 34:2616445d0823 378 <td></td>
dan_ackme 34:2616445d0823 379 <td class="paramtype">const char *&#160;</td>
dan_ackme 34:2616445d0823 380 <td class="paramname"><em>contextType</em>, </td>
dan_ackme 34:2616445d0823 381 </tr>
dan_ackme 34:2616445d0823 382 <tr>
dan_ackme 34:2616445d0823 383 <td class="paramkey"></td>
dan_ackme 34:2616445d0823 384 <td></td>
dan_ackme 34:2616445d0823 385 <td class="paramtype">bool&#160;</td>
dan_ackme 34:2616445d0823 386 <td class="paramname"><em>openOnly</em> = <code>true</code>, </td>
dan_ackme 34:2616445d0823 387 </tr>
dan_ackme 34:2616445d0823 388 <tr>
dan_ackme 34:2616445d0823 389 <td class="paramkey"></td>
dan_ackme 34:2616445d0823 390 <td></td>
dan_ackme 34:2616445d0823 391 <td class="paramtype">const char *&#160;</td>
dan_ackme 34:2616445d0823 392 <td class="paramname"><em>certFilename</em> = <code>NULL</code>&#160;</td>
dan_ackme 34:2616445d0823 393 </tr>
dan_ackme 34:2616445d0823 394 <tr>
dan_ackme 34:2616445d0823 395 <td></td>
dan_ackme 34:2616445d0823 396 <td>)</td>
dan_ackme 34:2616445d0823 397 <td></td><td></td>
dan_ackme 34:2616445d0823 398 </tr>
dan_ackme 34:2616445d0823 399 </table>
dan_ackme 34:2616445d0823 400 </div><div class="memdoc">
dan_ackme 34:2616445d0823 401
dan_ackme 34:2616445d0823 402 <p>Issue HTTP POST Request. </p>
dan_ackme 34:2616445d0823 403 <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>
dan_ackme 34:2616445d0823 404 <dl class="params"><dt>Parameters</dt><dd>
dan_ackme 34:2616445d0823 405 <table class="params">
dan_ackme 34:2616445d0823 406 <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>
dan_ackme 34:2616445d0823 407 <tr><td class="paramdir">[in]</td><td class="paramname">url</td><td>URL of HTTP POST request </td></tr>
dan_ackme 34:2616445d0823 408 <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>
dan_ackme 34:2616445d0823 409 <tr><td class="paramdir">[in]</td><td class="paramname">openOnly</td><td>Optional, if FALSE this will immediately issue the POST request. </td></tr>
dan_ackme 34:2616445d0823 410 <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>
dan_ackme 34:2616445d0823 411 </table>
dan_ackme 34:2616445d0823 412 </dd>
dan_ackme 34:2616445d0823 413 </dl>
dan_ackme 34:2616445d0823 414 <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>
dan_ackme 34:2616445d0823 415
dan_ackme 34:2616445d0823 416 </div>
dan_ackme 34:2616445d0823 417 </div>
dan_ackme 34:2616445d0823 418 </div><!-- contents -->
dan_ackme 34:2616445d0823 419 </div><!-- doc-content -->
dan_ackme 34:2616445d0823 420 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
dan_ackme 34:2616445d0823 421 <ul>
dan_ackme 34:2616445d0823 422 <li class="footer">&copy; ACKme Networks 2014</li>
dan_ackme 34:2616445d0823 423 </ul>
dan_ackme 34:2616445d0823 424 </div>
dan_ackme 34:2616445d0823 425 </body>
dan_ackme 34:2616445d0823 426 </html>