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/html/group__api__socket__misc.html@29:b6af04b77a56, 2014-10-27 (annotated)

Committer:
dan_ackme
Date:
Mon Oct 27 13:42:26 2014 -0700
Revision:
29:b6af04b77a56
Parent:
26:8067e3d463d3 
refactored library layout

Who changed what in which revision?

UserRevisionLine numberNew 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>&nbsp;</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>&nbsp;</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&#160;Overview</span></a></li>
dan_ackme 13:2b51f5267c92 47 <li><a href="modules.html"><span>Library&#160;API</span></a></li>
dan_ackme 13:2b51f5267c92 48 <li><a href="examples.html"><span>API&#160;Examples</span></a></li>
dan_ackme 10:735194df0097 49 <li><a href="annotated.html"><span>Classes</span></a></li>
dan_ackme 26:8067e3d463d3 50 <li><a href="http://wiconnect.ack.me/2.0/general_overview"><span>WiConnect&#160;Reference&#160;Manual</span></a></li>
dan_ackme 13:2b51f5267c92 51 <li><a href="http://www.ack.me/WiConnect"><span>ACKme&#160;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__misc.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">&#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 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">Miscellaneous 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>Miscellaneous socket 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: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">wiconnect::SocketInterface::closeAllSockets</a> ()</td></tr>
dan_ackme 13:2b51f5267c92 113 <tr class="memdesc:ga8a80d96efac7cc514fe7fc61d1878106"><td class="mdescLeft">&#160;</td><td class="mdescRight">Close all opened sockets. <a href="#ga8a80d96efac7cc514fe7fc61d1878106">More...</a><br /></td></tr>
dan_ackme 11:ea484e1b7fc4 114 <tr class="separator:ga8a80d96efac7cc514fe7fc61d1878106"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 29:b6af04b77a56 115 <tr class="memitem:gab24204ef309b6e7a52b03b35a7046b45"><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#gab24204ef309b6e7a52b03b35a7046b45">wiconnect::SocketInterface::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 GPIO_IRQ_ARG)</td></tr>
dan_ackme 29:b6af04b77a56 116 <tr class="memdesc:gab24204ef309b6e7a52b03b35a7046b45"><td class="mdescLeft">&#160;</td><td class="mdescRight">Connect to remote server. <a href="#gab24204ef309b6e7a52b03b35a7046b45">More...</a><br /></td></tr>
dan_ackme 29:b6af04b77a56 117 <tr class="separator:gab24204ef309b6e7a52b03b35a7046b45"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 11:ea484e1b7fc4 118 </table>
dan_ackme 11:ea484e1b7fc4 119 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
dan_ackme 13:2b51f5267c92 120 <p>Miscellaneous socket methods. </p>
dan_ackme 13:2b51f5267c92 121 <h2 class="groupheader">Function Documentation</h2>
dan_ackme 13:2b51f5267c92 122 <a class="anchor" id="ga8a80d96efac7cc514fe7fc61d1878106"></a>
dan_ackme 13:2b51f5267c92 123 <div class="memitem">
dan_ackme 13:2b51f5267c92 124 <div class="memproto">
dan_ackme 13:2b51f5267c92 125 <table class="memname">
dan_ackme 13:2b51f5267c92 126 <tr>
dan_ackme 13:2b51f5267c92 127 <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::SocketInterface::closeAllSockets </td>
dan_ackme 13:2b51f5267c92 128 <td>(</td>
dan_ackme 13:2b51f5267c92 129 <td class="paramname"></td><td>)</td>
dan_ackme 13:2b51f5267c92 130 <td></td>
dan_ackme 13:2b51f5267c92 131 </tr>
dan_ackme 13:2b51f5267c92 132 </table>
dan_ackme 13:2b51f5267c92 133 </div><div class="memdoc">
dan_ackme 13:2b51f5267c92 134
dan_ackme 13:2b51f5267c92 135 <p>Close all opened sockets. </p>
dan_ackme 17:7268f365676b 136 <dl class="section note"><dt>Note</dt><dd>This closes all open sockets on the MODULE side. Socket objects on the HOST side will be still open until issuing a read/write command to the module using the socket handle.</dd></dl>
dan_ackme 13:2b51f5267c92 137 <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 138
dan_ackme 13:2b51f5267c92 139 </div>
dan_ackme 13:2b51f5267c92 140 </div>
dan_ackme 29:b6af04b77a56 141 <a class="anchor" id="gab24204ef309b6e7a52b03b35a7046b45"></a>
dan_ackme 13:2b51f5267c92 142 <div class="memitem">
dan_ackme 13:2b51f5267c92 143 <div class="memproto">
dan_ackme 13:2b51f5267c92 144 <table class="memname">
dan_ackme 13:2b51f5267c92 145 <tr>
dan_ackme 13:2b51f5267c92 146 <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::SocketInterface::connect </td>
dan_ackme 13:2b51f5267c92 147 <td>(</td>
dan_ackme 17:7268f365676b 148 <td class="paramtype"><a class="el" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> &amp;&#160;</td>
dan_ackme 13:2b51f5267c92 149 <td class="paramname"><em>socket</em>, </td>
dan_ackme 13:2b51f5267c92 150 </tr>
dan_ackme 13:2b51f5267c92 151 <tr>
dan_ackme 13:2b51f5267c92 152 <td class="paramkey"></td>
dan_ackme 13:2b51f5267c92 153 <td></td>
dan_ackme 13:2b51f5267c92 154 <td class="paramtype"><a class="el" href="group__api__socket__types.html#ga69dc55558df4c81599c5fb3dff98756d">SocketType</a>&#160;</td>
dan_ackme 13:2b51f5267c92 155 <td class="paramname"><em>type</em>, </td>
dan_ackme 13:2b51f5267c92 156 </tr>
dan_ackme 13:2b51f5267c92 157 <tr>
dan_ackme 13:2b51f5267c92 158 <td class="paramkey"></td>
dan_ackme 13:2b51f5267c92 159 <td></td>
dan_ackme 13:2b51f5267c92 160 <td class="paramtype">const char *&#160;</td>
dan_ackme 13:2b51f5267c92 161 <td class="paramname"><em>host</em>, </td>
dan_ackme 13:2b51f5267c92 162 </tr>
dan_ackme 13:2b51f5267c92 163 <tr>
dan_ackme 13:2b51f5267c92 164 <td class="paramkey"></td>
dan_ackme 13:2b51f5267c92 165 <td></td>
dan_ackme 13:2b51f5267c92 166 <td class="paramtype">uint16_t&#160;</td>
dan_ackme 13:2b51f5267c92 167 <td class="paramname"><em>remortPort</em>, </td>
dan_ackme 13:2b51f5267c92 168 </tr>
dan_ackme 13:2b51f5267c92 169 <tr>
dan_ackme 13:2b51f5267c92 170 <td class="paramkey"></td>
dan_ackme 13:2b51f5267c92 171 <td></td>
dan_ackme 13:2b51f5267c92 172 <td class="paramtype">uint16_t&#160;</td>
dan_ackme 13:2b51f5267c92 173 <td class="paramname"><em>localPort</em>, </td>
dan_ackme 13:2b51f5267c92 174 </tr>
dan_ackme 13:2b51f5267c92 175 <tr>
dan_ackme 13:2b51f5267c92 176 <td class="paramkey"></td>
dan_ackme 13:2b51f5267c92 177 <td></td>
dan_ackme 29:b6af04b77a56 178 <td class="paramtype">const void *args&#160;</td>
dan_ackme 29:b6af04b77a56 179 <td class="paramname"><em>GPIO_IRQ_ARG</em>&#160;</td>
dan_ackme 13:2b51f5267c92 180 </tr>
dan_ackme 13:2b51f5267c92 181 <tr>
dan_ackme 13:2b51f5267c92 182 <td></td>
dan_ackme 13:2b51f5267c92 183 <td>)</td>
dan_ackme 13:2b51f5267c92 184 <td></td><td></td>
dan_ackme 13:2b51f5267c92 185 </tr>
dan_ackme 13:2b51f5267c92 186 </table>
dan_ackme 13:2b51f5267c92 187 </div><div class="memdoc">
dan_ackme 13:2b51f5267c92 188
dan_ackme 13:2b51f5267c92 189 <p>Connect to remote server. </p>
dan_ackme 13:2b51f5267c92 190 <p>This is the base method used by all the other connect methods.</p>
dan_ackme 13:2b51f5267c92 191 <dl class="params"><dt>Parameters</dt><dd>
dan_ackme 13:2b51f5267c92 192 <table class="params">
dan_ackme 17:7268f365676b 193 <tr><td class="paramdir">[out]</td><td class="paramname">socket</td><td><a class="el" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> object of opened connection. </td></tr>
dan_ackme 13:2b51f5267c92 194 <tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>The <a class="el" href="group__api__socket__types.html#ga69dc55558df4c81599c5fb3dff98756d">SocketType</a> of connection to open </td></tr>
dan_ackme 13:2b51f5267c92 195 <tr><td class="paramdir">[in]</td><td class="paramname">host</td><td>The host/IP address of the remote server </td></tr>
dan_ackme 13:2b51f5267c92 196 <tr><td class="paramdir">[in]</td><td class="paramname">remortPort</td><td>The port of the remote server </td></tr>
dan_ackme 13:2b51f5267c92 197 <tr><td class="paramdir">[in]</td><td class="paramname">localPort</td><td>The port of the module's side of the connection </td></tr>
dan_ackme 13:2b51f5267c92 198 <tr><td class="paramdir">[in]</td><td class="paramname">args</td><td>Depedent on the connection type </td></tr>
dan_ackme 29:b6af04b77a56 199 <tr><td class="paramdir">[in]</td><td class="paramname">irqPin</td><td>Data available external interrupt pin. See registerSocketIrqHandler() for more info </td></tr>
dan_ackme 13:2b51f5267c92 200 </table>
dan_ackme 13:2b51f5267c92 201 </dd>
dan_ackme 13:2b51f5267c92 202 </dl>
dan_ackme 13:2b51f5267c92 203 <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 204
dan_ackme 13:2b51f5267c92 205 </div>
dan_ackme 13:2b51f5267c92 206 </div>
dan_ackme 10:735194df0097 207 </div><!-- contents -->
dan_ackme 10:735194df0097 208 </div><!-- doc-content -->
dan_ackme 10:735194df0097 209 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
dan_ackme 10:735194df0097 210 <ul>
dan_ackme 13:2b51f5267c92 211 <li class="footer">&copy; ACKme Networks 2014</li>
dan_ackme 10:735194df0097 212 </ul>
dan_ackme 10:735194df0097 213 </div>
dan_ackme 10:735194df0097 214 </body>
dan_ackme 13:2b51f5267c92 215 </html>