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