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__tcp.html@21:17bb3eddcbae, 2014-08-26 (annotated)

Committer:
dan_ackme
Date:
Tue Aug 26 16:38:19 2014 -0700
Revision:
21:17bb3eddcbae
Parent:
17:7268f365676b
Child:
26:8067e3d463d3
Add TCP server API

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 13:2b51f5267c92 50 <li><a href="http://wiconnect.ack.me/1.2/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__tcp.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">TCP 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>TCP 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 21:17bb3eddcbae 112 <tr class="memitem:ga4a788d604d759b5da51f682b998b9bd2"><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#ga4a788d604d759b5da51f682b998b9bd2">wiconnect::SocketInterface::tcpConnect</a> (<a class="el" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> &amp;socket, const char *host, uint16_t remortPort, <a class="el" href="group__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> irqPin=<a class="el" href="group__api__core__macro.html#gaa1dbeca66111f3a22d0ee6b122d69270">PIN_NC</a>)</td></tr>
dan_ackme 21:17bb3eddcbae 113 <tr class="memdesc:ga4a788d604d759b5da51f682b998b9bd2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Connect to remote TCP server. <a href="#ga4a788d604d759b5da51f682b998b9bd2">More...</a><br /></td></tr>
dan_ackme 21:17bb3eddcbae 114 <tr class="separator:ga4a788d604d759b5da51f682b998b9bd2"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 21:17bb3eddcbae 115 <tr class="memitem:ga563831b33089437233f128483d034578"><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#ga563831b33089437233f128483d034578">wiconnect::SocketInterface::tcpListen</a> (uint16_t listeningPort, int maxClients=0, <a class="el" href="group__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> irqPin=<a class="el" href="group__api__core__macro.html#gaa1dbeca66111f3a22d0ee6b122d69270">PIN_NC</a>)</td></tr>
dan_ackme 21:17bb3eddcbae 116 <tr class="memdesc:ga563831b33089437233f128483d034578"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start internal TCP server and listen on specified port. <a href="#ga563831b33089437233f128483d034578">More...</a><br /></td></tr>
dan_ackme 21:17bb3eddcbae 117 <tr class="separator:ga563831b33089437233f128483d034578"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 21:17bb3eddcbae 118 <tr class="memitem:ga0ea4efc810c7c5a9fbd96fcc627633b3"><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#ga0ea4efc810c7c5a9fbd96fcc627633b3">wiconnect::SocketInterface::tcpAccept</a> (<a class="el" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> &amp;socket, int timeoutMs=<a class="el" href="group__api__core__macro.html#ga580e5f45fee866c845e0d3fd1eb1744a">WICONNECT_WAIT_FOREVER</a>)</td></tr>
dan_ackme 21:17bb3eddcbae 119 <tr class="memdesc:ga0ea4efc810c7c5a9fbd96fcc627633b3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wait for next client to connect to TCP server. <a href="#ga0ea4efc810c7c5a9fbd96fcc627633b3">More...</a><br /></td></tr>
dan_ackme 21:17bb3eddcbae 120 <tr class="separator:ga0ea4efc810c7c5a9fbd96fcc627633b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 21:17bb3eddcbae 121 <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">wiconnect::SocketInterface::tcpServerStop</a> (void)</td></tr>
dan_ackme 21:17bb3eddcbae 122 <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="#ga3d0137ebe308674e75f81457c38679d0">More...</a><br /></td></tr>
dan_ackme 21:17bb3eddcbae 123 <tr class="separator:ga3d0137ebe308674e75f81457c38679d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 11:ea484e1b7fc4 124 </table>
dan_ackme 11:ea484e1b7fc4 125 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
dan_ackme 13:2b51f5267c92 126 <p>TCP methods. </p>
dan_ackme 13:2b51f5267c92 127 <h2 class="groupheader">Function Documentation</h2>
dan_ackme 21:17bb3eddcbae 128 <a class="anchor" id="ga0ea4efc810c7c5a9fbd96fcc627633b3"></a>
dan_ackme 21:17bb3eddcbae 129 <div class="memitem">
dan_ackme 21:17bb3eddcbae 130 <div class="memproto">
dan_ackme 21:17bb3eddcbae 131 <table class="memname">
dan_ackme 21:17bb3eddcbae 132 <tr>
dan_ackme 21:17bb3eddcbae 133 <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::SocketInterface::tcpAccept </td>
dan_ackme 21:17bb3eddcbae 134 <td>(</td>
dan_ackme 21:17bb3eddcbae 135 <td class="paramtype"><a class="el" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> &amp;&#160;</td>
dan_ackme 21:17bb3eddcbae 136 <td class="paramname"><em>socket</em>, </td>
dan_ackme 21:17bb3eddcbae 137 </tr>
dan_ackme 21:17bb3eddcbae 138 <tr>
dan_ackme 21:17bb3eddcbae 139 <td class="paramkey"></td>
dan_ackme 21:17bb3eddcbae 140 <td></td>
dan_ackme 21:17bb3eddcbae 141 <td class="paramtype">int&#160;</td>
dan_ackme 21:17bb3eddcbae 142 <td class="paramname"><em>timeoutMs</em> = <code><a class="el" href="group__api__core__macro.html#ga580e5f45fee866c845e0d3fd1eb1744a">WICONNECT_WAIT_FOREVER</a></code>&#160;</td>
dan_ackme 21:17bb3eddcbae 143 </tr>
dan_ackme 21:17bb3eddcbae 144 <tr>
dan_ackme 21:17bb3eddcbae 145 <td></td>
dan_ackme 21:17bb3eddcbae 146 <td>)</td>
dan_ackme 21:17bb3eddcbae 147 <td></td><td></td>
dan_ackme 21:17bb3eddcbae 148 </tr>
dan_ackme 21:17bb3eddcbae 149 </table>
dan_ackme 21:17bb3eddcbae 150 </div><div class="memdoc">
dan_ackme 21:17bb3eddcbae 151
dan_ackme 21:17bb3eddcbae 152 <p>Wait for next client to connect to TCP server. </p>
dan_ackme 21:17bb3eddcbae 153 <dl class="params"><dt>Parameters</dt><dd>
dan_ackme 21:17bb3eddcbae 154 <table class="params">
dan_ackme 21:17bb3eddcbae 155 <tr><td class="paramdir">[in]</td><td class="paramname">socket</td><td>Socket to connected client </td></tr>
dan_ackme 21:17bb3eddcbae 156 <tr><td class="paramdir">[in]</td><td class="paramname">timeoutMs</td><td>Optional, specifiy maximum amount of time in ms to wait for a client </td></tr>
dan_ackme 21:17bb3eddcbae 157 </table>
dan_ackme 21:17bb3eddcbae 158 </dd>
dan_ackme 21:17bb3eddcbae 159 </dl>
dan_ackme 21:17bb3eddcbae 160 <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 21:17bb3eddcbae 161
dan_ackme 21:17bb3eddcbae 162 </div>
dan_ackme 21:17bb3eddcbae 163 </div>
dan_ackme 21:17bb3eddcbae 164 <a class="anchor" id="ga4a788d604d759b5da51f682b998b9bd2"></a>
dan_ackme 13:2b51f5267c92 165 <div class="memitem">
dan_ackme 13:2b51f5267c92 166 <div class="memproto">
dan_ackme 13:2b51f5267c92 167 <table class="memname">
dan_ackme 13:2b51f5267c92 168 <tr>
dan_ackme 13:2b51f5267c92 169 <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::SocketInterface::tcpConnect </td>
dan_ackme 13:2b51f5267c92 170 <td>(</td>
dan_ackme 17:7268f365676b 171 <td class="paramtype"><a class="el" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> &amp;&#160;</td>
dan_ackme 13:2b51f5267c92 172 <td class="paramname"><em>socket</em>, </td>
dan_ackme 13:2b51f5267c92 173 </tr>
dan_ackme 13:2b51f5267c92 174 <tr>
dan_ackme 13:2b51f5267c92 175 <td class="paramkey"></td>
dan_ackme 13:2b51f5267c92 176 <td></td>
dan_ackme 13:2b51f5267c92 177 <td class="paramtype">const char *&#160;</td>
dan_ackme 13:2b51f5267c92 178 <td class="paramname"><em>host</em>, </td>
dan_ackme 13:2b51f5267c92 179 </tr>
dan_ackme 13:2b51f5267c92 180 <tr>
dan_ackme 13:2b51f5267c92 181 <td class="paramkey"></td>
dan_ackme 13:2b51f5267c92 182 <td></td>
dan_ackme 13:2b51f5267c92 183 <td class="paramtype">uint16_t&#160;</td>
dan_ackme 13:2b51f5267c92 184 <td class="paramname"><em>remortPort</em>, </td>
dan_ackme 13:2b51f5267c92 185 </tr>
dan_ackme 13:2b51f5267c92 186 <tr>
dan_ackme 13:2b51f5267c92 187 <td class="paramkey"></td>
dan_ackme 13:2b51f5267c92 188 <td></td>
dan_ackme 13:2b51f5267c92 189 <td class="paramtype"><a class="el" href="group__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a>&#160;</td>
dan_ackme 21:17bb3eddcbae 190 <td class="paramname"><em>irqPin</em> = <code><a class="el" href="group__api__core__macro.html#gaa1dbeca66111f3a22d0ee6b122d69270">PIN_NC</a></code>&#160;</td>
dan_ackme 13:2b51f5267c92 191 </tr>
dan_ackme 13:2b51f5267c92 192 <tr>
dan_ackme 13:2b51f5267c92 193 <td></td>
dan_ackme 13:2b51f5267c92 194 <td>)</td>
dan_ackme 13:2b51f5267c92 195 <td></td><td></td>
dan_ackme 13:2b51f5267c92 196 </tr>
dan_ackme 13:2b51f5267c92 197 </table>
dan_ackme 13:2b51f5267c92 198 </div><div class="memdoc">
dan_ackme 13:2b51f5267c92 199
dan_ackme 13:2b51f5267c92 200 <p>Connect to remote TCP server. </p>
dan_ackme 13:2b51f5267c92 201 <dl class="params"><dt>Parameters</dt><dd>
dan_ackme 13:2b51f5267c92 202 <table class="params">
dan_ackme 17:7268f365676b 203 <tr><td class="paramdir">[out]</td><td class="paramname">socket</td><td>TCP <a class="el" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> object of opened connection. </td></tr>
dan_ackme 13:2b51f5267c92 204 <tr><td class="paramdir">[in]</td><td class="paramname">host</td><td>The host/IP address of the remote TCP server </td></tr>
dan_ackme 13:2b51f5267c92 205 <tr><td class="paramdir">[in]</td><td class="paramname">remortPort</td><td>The port of the remote server </td></tr>
dan_ackme 13:2b51f5267c92 206 <tr><td class="paramdir">[in]</td><td class="paramname">irqPin</td><td>Optional, Data available external interrupt pin. See <a class="el" href="group__api__socket__misc.html#ga94d1eb5407cb8b60ad366ecbe0e1b52a" title="Register a host pin as an external interrupt. When the external interrupt is triggered, the supplied callback is executed. ">registerSocketIrqHandler()</a> for more info </td></tr>
dan_ackme 13:2b51f5267c92 207 </table>
dan_ackme 13:2b51f5267c92 208 </dd>
dan_ackme 13:2b51f5267c92 209 </dl>
dan_ackme 13:2b51f5267c92 210 <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 211
dan_ackme 13:2b51f5267c92 212 </div>
dan_ackme 13:2b51f5267c92 213 </div>
dan_ackme 21:17bb3eddcbae 214 <a class="anchor" id="ga563831b33089437233f128483d034578"></a>
dan_ackme 21:17bb3eddcbae 215 <div class="memitem">
dan_ackme 21:17bb3eddcbae 216 <div class="memproto">
dan_ackme 21:17bb3eddcbae 217 <table class="memname">
dan_ackme 21:17bb3eddcbae 218 <tr>
dan_ackme 21:17bb3eddcbae 219 <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::SocketInterface::tcpListen </td>
dan_ackme 21:17bb3eddcbae 220 <td>(</td>
dan_ackme 21:17bb3eddcbae 221 <td class="paramtype">uint16_t&#160;</td>
dan_ackme 21:17bb3eddcbae 222 <td class="paramname"><em>listeningPort</em>, </td>
dan_ackme 21:17bb3eddcbae 223 </tr>
dan_ackme 21:17bb3eddcbae 224 <tr>
dan_ackme 21:17bb3eddcbae 225 <td class="paramkey"></td>
dan_ackme 21:17bb3eddcbae 226 <td></td>
dan_ackme 21:17bb3eddcbae 227 <td class="paramtype">int&#160;</td>
dan_ackme 21:17bb3eddcbae 228 <td class="paramname"><em>maxClients</em> = <code>0</code>, </td>
dan_ackme 21:17bb3eddcbae 229 </tr>
dan_ackme 21:17bb3eddcbae 230 <tr>
dan_ackme 21:17bb3eddcbae 231 <td class="paramkey"></td>
dan_ackme 21:17bb3eddcbae 232 <td></td>
dan_ackme 21:17bb3eddcbae 233 <td class="paramtype"><a class="el" href="group__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a>&#160;</td>
dan_ackme 21:17bb3eddcbae 234 <td class="paramname"><em>irqPin</em> = <code><a class="el" href="group__api__core__macro.html#gaa1dbeca66111f3a22d0ee6b122d69270">PIN_NC</a></code>&#160;</td>
dan_ackme 21:17bb3eddcbae 235 </tr>
dan_ackme 21:17bb3eddcbae 236 <tr>
dan_ackme 21:17bb3eddcbae 237 <td></td>
dan_ackme 21:17bb3eddcbae 238 <td>)</td>
dan_ackme 21:17bb3eddcbae 239 <td></td><td></td>
dan_ackme 21:17bb3eddcbae 240 </tr>
dan_ackme 21:17bb3eddcbae 241 </table>
dan_ackme 21:17bb3eddcbae 242 </div><div class="memdoc">
dan_ackme 21:17bb3eddcbae 243
dan_ackme 21:17bb3eddcbae 244 <p>Start internal TCP server and listen on specified port. </p>
dan_ackme 21:17bb3eddcbae 245 <dl class="params"><dt>Parameters</dt><dd>
dan_ackme 21:17bb3eddcbae 246 <table class="params">
dan_ackme 21:17bb3eddcbae 247 <tr><td class="paramdir">[in]</td><td class="paramname">listeningPort</td><td>The local port the server should listen on </td></tr>
dan_ackme 21:17bb3eddcbae 248 <tr><td class="paramdir">[in]</td><td class="paramname">maxClients</td><td>Optional, the maximum simultaneous connected clients, 0 is default, 1-8 valid range </td></tr>
dan_ackme 21:17bb3eddcbae 249 <tr><td class="paramdir">[in]</td><td class="paramname">irqPin</td><td>Optional, Data available external interrupt pin. See <a class="el" href="group__api__socket__misc.html#ga94d1eb5407cb8b60ad366ecbe0e1b52a" title="Register a host pin as an external interrupt. When the external interrupt is triggered, the supplied callback is executed. ">registerSocketIrqHandler()</a> for more info </td></tr>
dan_ackme 21:17bb3eddcbae 250 </table>
dan_ackme 21:17bb3eddcbae 251 </dd>
dan_ackme 21:17bb3eddcbae 252 </dl>
dan_ackme 21:17bb3eddcbae 253 <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 21:17bb3eddcbae 254
dan_ackme 21:17bb3eddcbae 255 </div>
dan_ackme 21:17bb3eddcbae 256 </div>
dan_ackme 21:17bb3eddcbae 257 <a class="anchor" id="ga3d0137ebe308674e75f81457c38679d0"></a>
dan_ackme 21:17bb3eddcbae 258 <div class="memitem">
dan_ackme 21:17bb3eddcbae 259 <div class="memproto">
dan_ackme 21:17bb3eddcbae 260 <table class="memname">
dan_ackme 21:17bb3eddcbae 261 <tr>
dan_ackme 21:17bb3eddcbae 262 <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::SocketInterface::tcpServerStop </td>
dan_ackme 21:17bb3eddcbae 263 <td>(</td>
dan_ackme 21:17bb3eddcbae 264 <td class="paramtype">void&#160;</td>
dan_ackme 21:17bb3eddcbae 265 <td class="paramname"></td><td>)</td>
dan_ackme 21:17bb3eddcbae 266 <td></td>
dan_ackme 21:17bb3eddcbae 267 </tr>
dan_ackme 21:17bb3eddcbae 268 </table>
dan_ackme 21:17bb3eddcbae 269 </div><div class="memdoc">
dan_ackme 21:17bb3eddcbae 270
dan_ackme 21:17bb3eddcbae 271 <p>Stop TCP server from listening on port. Close all connected clients. </p>
dan_ackme 21:17bb3eddcbae 272 <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 21:17bb3eddcbae 273
dan_ackme 21:17bb3eddcbae 274 </div>
dan_ackme 21:17bb3eddcbae 275 </div>
dan_ackme 10:735194df0097 276 </div><!-- contents -->
dan_ackme 10:735194df0097 277 </div><!-- doc-content -->
dan_ackme 10:735194df0097 278 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
dan_ackme 10:735194df0097 279 <ul>
dan_ackme 13:2b51f5267c92 280 <li class="footer">&copy; ACKme Networks 2014</li>
dan_ackme 10:735194df0097 281 </ul>
dan_ackme 10:735194df0097 282 </div>
dan_ackme 10:735194df0097 283 </body>
dan_ackme 13:2b51f5267c92 284 </html>