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/classwiconnect_1_1_socket_interface.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 class="current"><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 id="navrow2" class="tabs2">
dan_ackme 34:2616445d0823 72 <ul class="tablist">
dan_ackme 34:2616445d0823 73 <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
dan_ackme 34:2616445d0823 74 <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
dan_ackme 34:2616445d0823 75 <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
dan_ackme 34:2616445d0823 76 <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
dan_ackme 34:2616445d0823 77 </ul>
dan_ackme 34:2616445d0823 78 </div>
dan_ackme 34:2616445d0823 79 </div><!-- top -->
dan_ackme 34:2616445d0823 80 <div id="side-nav" class="ui-resizable side-nav-resizable">
dan_ackme 34:2616445d0823 81 <div id="nav-tree">
dan_ackme 34:2616445d0823 82 <div id="nav-tree-contents">
dan_ackme 34:2616445d0823 83 <div id="nav-sync" class="sync"></div>
dan_ackme 34:2616445d0823 84 </div>
dan_ackme 34:2616445d0823 85 </div>
dan_ackme 34:2616445d0823 86 <div id="splitbar" style="-moz-user-select:none;"
dan_ackme 34:2616445d0823 87 class="ui-resizable-handle">
dan_ackme 34:2616445d0823 88 </div>
dan_ackme 34:2616445d0823 89 </div>
dan_ackme 34:2616445d0823 90 <script type="text/javascript">
dan_ackme 34:2616445d0823 91 $(document).ready(function(){initNavTree('classwiconnect_1_1_socket_interface.html','');});
dan_ackme 34:2616445d0823 92 </script>
dan_ackme 34:2616445d0823 93 <div id="doc-content">
dan_ackme 34:2616445d0823 94 <!-- window showing the filter options -->
dan_ackme 34:2616445d0823 95 <div id="MSearchSelectWindow"
dan_ackme 34:2616445d0823 96 onmouseover="return searchBox.OnSearchSelectShow()"
dan_ackme 34:2616445d0823 97 onmouseout="return searchBox.OnSearchSelectHide()"
dan_ackme 34:2616445d0823 98 onkeydown="return searchBox.OnSearchSelectKey(event)">
dan_ackme 34:2616445d0823 99 <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 100
dan_ackme 34:2616445d0823 101 <!-- iframe showing the search results (closed by default) -->
dan_ackme 34:2616445d0823 102 <div id="MSearchResultsWindow">
dan_ackme 34:2616445d0823 103 <iframe src="javascript:void(0)" frameborder="0"
dan_ackme 34:2616445d0823 104 name="MSearchResults" id="MSearchResults">
dan_ackme 34:2616445d0823 105 </iframe>
dan_ackme 34:2616445d0823 106 </div>
dan_ackme 34:2616445d0823 107
dan_ackme 34:2616445d0823 108 <div class="header">
dan_ackme 34:2616445d0823 109 <div class="summary">
dan_ackme 34:2616445d0823 110 <a href="#pub-methods">Public Member Functions</a> &#124;
dan_ackme 34:2616445d0823 111 <a href="classwiconnect_1_1_socket_interface-members.html">List of all members</a> </div>
dan_ackme 34:2616445d0823 112 <div class="headertitle">
dan_ackme 34:2616445d0823 113 <div class="title">wiconnect::SocketInterface Class Reference<div class="ingroups"><a class="el" href="group__api__socket__types.html">Types</a></div></div> </div>
dan_ackme 34:2616445d0823 114 </div><!--header-->
dan_ackme 34:2616445d0823 115 <div class="contents">
dan_ackme 34:2616445d0823 116
dan_ackme 34:2616445d0823 117 <p>The provides an interface for creating TCP/UDP/TLS/HTTP client sockets. A client socket connects to a remote server.
dan_ackme 34:2616445d0823 118 <a href="classwiconnect_1_1_socket_interface.html#details">More...</a></p>
dan_ackme 34:2616445d0823 119
dan_ackme 34:2616445d0823 120 <p><code>#include &lt;<a class="el" href="_socket_interface_8h_source.html">SocketInterface.h</a>&gt;</code></p>
dan_ackme 34:2616445d0823 121
dan_ackme 34:2616445d0823 122 <p>Inherited by <a class="el" href="classwiconnect_1_1_wiconnect.html">wiconnect::Wiconnect</a>.</p>
dan_ackme 34:2616445d0823 123 <table class="memberdecls">
dan_ackme 34:2616445d0823 124 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
dan_ackme 34:2616445d0823 125 Public Member Functions</h2></td></tr>
dan_ackme 34:2616445d0823 126 <tr class="memitem:ga8a80d96efac7cc514fe7fc61d1878106"><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__misc.html#ga8a80d96efac7cc514fe7fc61d1878106">closeAllSockets</a> ()</td></tr>
dan_ackme 34:2616445d0823 127 <tr class="memdesc:ga8a80d96efac7cc514fe7fc61d1878106"><td class="mdescLeft">&#160;</td><td class="mdescRight">Close all opened sockets. <a href="group__api__socket__misc.html#ga8a80d96efac7cc514fe7fc61d1878106">More...</a><br /></td></tr>
dan_ackme 34:2616445d0823 128 <tr class="separator:ga8a80d96efac7cc514fe7fc61d1878106"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 34:2616445d0823 129 <tr class="memitem:ga3316a2d22f865774960f3af90b54baf0"><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__misc.html#ga3316a2d22f865774960f3af90b54baf0">connect</a> (<a class="el" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> &amp;socket, <a class="el" href="group__api__socket__types.html#ga69dc55558df4c81599c5fb3dff98756d">SocketType</a> type, const char *host, uint16_t remortPort, uint16_t localPort, const void *args)</td></tr>
dan_ackme 34:2616445d0823 130 <tr class="memdesc:ga3316a2d22f865774960f3af90b54baf0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Connect to remote server. <a href="group__api__socket__misc.html#ga3316a2d22f865774960f3af90b54baf0">More...</a><br /></td></tr>
dan_ackme 34:2616445d0823 131 <tr class="separator:ga3316a2d22f865774960f3af90b54baf0"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 34:2616445d0823 132 <tr class="memitem:gaddca62644b64e2640abdc1fc5f526559"><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__tcp.html#gaddca62644b64e2640abdc1fc5f526559">tcpConnect</a> (<a class="el" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> &amp;socket, const char *host, uint16_t remortPort)</td></tr>
dan_ackme 34:2616445d0823 133 <tr class="memdesc:gaddca62644b64e2640abdc1fc5f526559"><td class="mdescLeft">&#160;</td><td class="mdescRight">Connect to remote TCP server. <a href="group__api__socket__tcp.html#gaddca62644b64e2640abdc1fc5f526559">More...</a><br /></td></tr>
dan_ackme 34:2616445d0823 134 <tr class="separator:gaddca62644b64e2640abdc1fc5f526559"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 34:2616445d0823 135 <tr class="memitem:gadf3ba6b5941028eec0442c3e8e9dfc2f"><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__tcp.html#gadf3ba6b5941028eec0442c3e8e9dfc2f">tcpListen</a> (uint16_t listeningPort, int maxClients=0)</td></tr>
dan_ackme 34:2616445d0823 136 <tr class="memdesc:gadf3ba6b5941028eec0442c3e8e9dfc2f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start internal TCP server and listen on specified port. <a href="group__api__socket__tcp.html#gadf3ba6b5941028eec0442c3e8e9dfc2f">More...</a><br /></td></tr>
dan_ackme 34:2616445d0823 137 <tr class="separator:gadf3ba6b5941028eec0442c3e8e9dfc2f"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 34:2616445d0823 138 <tr class="memitem:ga9e12bc568b7e8d72152e53a90de13035"><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__tcp.html#ga9e12bc568b7e8d72152e53a90de13035">tcpAccept</a> (<a class="el" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> &amp;socket, uint32_t timeoutMs=<a class="el" href="group__api__core__macro.html#ga580e5f45fee866c845e0d3fd1eb1744a">WICONNECT_WAIT_FOREVER</a>)</td></tr>
dan_ackme 34:2616445d0823 139 <tr class="memdesc:ga9e12bc568b7e8d72152e53a90de13035"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wait for next client to connect to TCP server. <a href="group__api__socket__tcp.html#ga9e12bc568b7e8d72152e53a90de13035">More...</a><br /></td></tr>
dan_ackme 34:2616445d0823 140 <tr class="separator:ga9e12bc568b7e8d72152e53a90de13035"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 34:2616445d0823 141 <tr class="memitem:ga3d0137ebe308674e75f81457c38679d0"><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__tcp.html#ga3d0137ebe308674e75f81457c38679d0">tcpServerStop</a> (void)</td></tr>
dan_ackme 34:2616445d0823 142 <tr class="memdesc:ga3d0137ebe308674e75f81457c38679d0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stop TCP server from listening on port. Close all connected clients. <a href="group__api__socket__tcp.html#ga3d0137ebe308674e75f81457c38679d0">More...</a><br /></td></tr>
dan_ackme 34:2616445d0823 143 <tr class="separator:ga3d0137ebe308674e75f81457c38679d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 34:2616445d0823 144 <tr class="memitem:ga099eebadd568e150a9f2188d04444e96"><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__tls.html#ga099eebadd568e150a9f2188d04444e96">tlsConnect</a> (<a class="el" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> &amp;socket, const char *host, uint16_t remortPort, const char *certFilename=NULL)</td></tr>
dan_ackme 34:2616445d0823 145 <tr class="memdesc:ga099eebadd568e150a9f2188d04444e96"><td class="mdescLeft">&#160;</td><td class="mdescRight">Connect to remote TLS server. <a href="group__api__socket__tls.html#ga099eebadd568e150a9f2188d04444e96">More...</a><br /></td></tr>
dan_ackme 34:2616445d0823 146 <tr class="separator:ga099eebadd568e150a9f2188d04444e96"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 34:2616445d0823 147 <tr class="memitem:gac61e0445efcfa48fb98b5b2bc0b77119"><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__udp.html#gac61e0445efcfa48fb98b5b2bc0b77119">udpConnect</a> (<a class="el" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> &amp;socket, const char *host, uint16_t remortPort, uint16_t localPort=<a class="el" href="group__api__socket__macro.html#gae54117ebe433295ef992b9ca83c46d98">SOCKET_ANY_PORT</a>)</td></tr>
dan_ackme 34:2616445d0823 148 <tr class="memdesc:gac61e0445efcfa48fb98b5b2bc0b77119"><td class="mdescLeft">&#160;</td><td class="mdescRight">Connect to remote UDP server. <a href="group__api__socket__udp.html#gac61e0445efcfa48fb98b5b2bc0b77119">More...</a><br /></td></tr>
dan_ackme 34:2616445d0823 149 <tr class="separator:gac61e0445efcfa48fb98b5b2bc0b77119"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 34:2616445d0823 150 <tr class="memitem:ga067fb0d662d8e27e3f5b561ded29a51a"><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__udp.html#ga067fb0d662d8e27e3f5b561ded29a51a">udpListen</a> (<a class="el" href="classwiconnect_1_1_wiconnect_udp_server.html">WiconnectUdpServer</a> &amp;udpServer, uint16_t listeningPort)</td></tr>
dan_ackme 34:2616445d0823 151 <tr class="memdesc:ga067fb0d662d8e27e3f5b561ded29a51a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start a UDP server listening on the given port. <a href="group__api__socket__udp.html#ga067fb0d662d8e27e3f5b561ded29a51a">More...</a><br /></td></tr>
dan_ackme 34:2616445d0823 152 <tr class="separator:ga067fb0d662d8e27e3f5b561ded29a51a"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 34:2616445d0823 153 <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">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 154 <tr class="memdesc:ga181a03d883f60dff0c03b65e066f0eed"><td class="mdescLeft">&#160;</td><td class="mdescRight">Connect to remote HTTP server. <a href="group__api__socket__http.html#ga181a03d883f60dff0c03b65e066f0eed">More...</a><br /></td></tr>
dan_ackme 34:2616445d0823 155 <tr class="separator:ga181a03d883f60dff0c03b65e066f0eed"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 34:2616445d0823 156 <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">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 157 <tr class="memdesc:gac9b6c6a348f790cc8d43889dd72029f6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Issue HTTP GET Request. <a href="group__api__socket__http.html#gac9b6c6a348f790cc8d43889dd72029f6">More...</a><br /></td></tr>
dan_ackme 34:2616445d0823 158 <tr class="separator:gac9b6c6a348f790cc8d43889dd72029f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 34:2616445d0823 159 <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">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 160 <tr class="memdesc:ga1b6a3ebdbd164f0eb683fc335ef4d365"><td class="mdescLeft">&#160;</td><td class="mdescRight">Issue HTTP POST Request. <a href="group__api__socket__http.html#ga1b6a3ebdbd164f0eb683fc335ef4d365">More...</a><br /></td></tr>
dan_ackme 34:2616445d0823 161 <tr class="separator:ga1b6a3ebdbd164f0eb683fc335ef4d365"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 34:2616445d0823 162 <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">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 163 <tr class="memdesc:gabcb3d69b2b1718e7ebe1ed171dec1f85"><td class="mdescLeft">&#160;</td><td class="mdescRight">Issue HTTP HEAD Request. <a href="group__api__socket__http.html#gabcb3d69b2b1718e7ebe1ed171dec1f85">More...</a><br /></td></tr>
dan_ackme 34:2616445d0823 164 <tr class="separator:gabcb3d69b2b1718e7ebe1ed171dec1f85"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 34:2616445d0823 165 <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">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 166 <tr class="memdesc:gabed18edc44f464bac64ce8a6dc3617ec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add HTTP header key/value pair to opened HTTP request. <a href="group__api__socket__http.html#gabed18edc44f464bac64ce8a6dc3617ec">More...</a><br /></td></tr>
dan_ackme 34:2616445d0823 167 <tr class="separator:gabed18edc44f464bac64ce8a6dc3617ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 34:2616445d0823 168 <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">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 169 <tr class="memdesc:gadf59ca0783b89ee32f205e33f1bd5517"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the HTTP status code from HTTP request. <a href="group__api__socket__http.html#gadf59ca0783b89ee32f205e33f1bd5517">More...</a><br /></td></tr>
dan_ackme 34:2616445d0823 170 <tr class="separator:gadf59ca0783b89ee32f205e33f1bd5517"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 34:2616445d0823 171 </table>
dan_ackme 34:2616445d0823 172 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
dan_ackme 34:2616445d0823 173 <div class="textblock"><p>The provides an interface for creating TCP/UDP/TLS/HTTP client sockets. A client socket connects to a remote server. </p>
dan_ackme 34:2616445d0823 174 <dl class="section note"><dt>Note</dt><dd>This class is an interface to the <a class="el" href="classwiconnect_1_1_wiconnect.html" title="The root WiConnect library class. This class inheriets all WiConnect functionality. ">Wiconnect</a> class. It should never be independently instantiated or the parent of another class. </dd></dl>
dan_ackme 34:2616445d0823 175
dan_ackme 34:2616445d0823 176 <p>Definition at line <a class="el" href="_socket_interface_8h_source.html#l00063">63</a> of file <a class="el" href="_socket_interface_8h_source.html">SocketInterface.h</a>.</p>
dan_ackme 34:2616445d0823 177 </div><hr/>The documentation for this class was generated from the following file:<ul>
dan_ackme 34:2616445d0823 178 <li>C:/Users/reed/workspace/host-wiconnect/src/wiconnect/Wiconnect/api/<a class="el" href="_socket_interface_8h_source.html">SocketInterface.h</a></li>
dan_ackme 34:2616445d0823 179 </ul>
dan_ackme 34:2616445d0823 180 </div><!-- contents -->
dan_ackme 34:2616445d0823 181 </div><!-- doc-content -->
dan_ackme 34:2616445d0823 182 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
dan_ackme 34:2616445d0823 183 <ul>
dan_ackme 34:2616445d0823 184 <li class="footer">&copy; ACKme Networks 2014</li>
dan_ackme 34:2616445d0823 185 </ul>
dan_ackme 34:2616445d0823 186 </div>
dan_ackme 34:2616445d0823 187 </body>
dan_ackme 34:2616445d0823 188 </html>