ACKme / WiConnect

Host library for controlling a WiConnect enabled Wi-Fi module.

Dependents:   wiconnect-ota_example wiconnect-web_setup_example wiconnect-test-console wiconnect-tcp_server_example ... more

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

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

Who changed what in which revision?

UserRevisionLine numberNew contents of line
dan_ackme 34:2616445d0823 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
dan_ackme 34:2616445d0823 2 <html xmlns="http://www.w3.org/1999/xhtml">
dan_ackme 34:2616445d0823 3 <head>
dan_ackme 34:2616445d0823 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
dan_ackme 34:2616445d0823 5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
dan_ackme 34:2616445d0823 6 <title>ACKme WiConnect Host Library</title>
dan_ackme 34:2616445d0823 7 <link rel="icon" href="favicon.ico" type="image/x-icon">
dan_ackme 34:2616445d0823 8 <link rel="shortcut icon" href="favicon.ico" type="image/x-icon">
dan_ackme 34:2616445d0823 9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
dan_ackme 34:2616445d0823 10 <script type="text/javascript" src="jquery.js"></script>
dan_ackme 34:2616445d0823 11 <script type="text/javascript" src="dynsections.js"></script>
dan_ackme 34:2616445d0823 12 <link href="navtree.css" rel="stylesheet" type="text/css"/>
dan_ackme 34:2616445d0823 13 <script type="text/javascript" src="resize.js"></script>
dan_ackme 34:2616445d0823 14 <script type="text/javascript" src="navtree.js"></script>
dan_ackme 34:2616445d0823 15 <script type="text/javascript">
dan_ackme 34:2616445d0823 16 $(document).ready(initResizable);
dan_ackme 34:2616445d0823 17 $(window).load(resizeHeight);
dan_ackme 34:2616445d0823 18 </script>
dan_ackme 34:2616445d0823 19 <link href="search/search.css" rel="stylesheet" type="text/css"/>
dan_ackme 34:2616445d0823 20 <script type="text/javascript" src="search/search.js"></script>
dan_ackme 34:2616445d0823 21 <script type="text/javascript">
dan_ackme 34:2616445d0823 22 $(document).ready(function() { searchBox.OnSelectItem(0); });
dan_ackme 34:2616445d0823 23 </script>
dan_ackme 34:2616445d0823 24 <link href="doxygen.css" rel="stylesheet" type="text/css" />
dan_ackme 34:2616445d0823 25 </head>
dan_ackme 34:2616445d0823 26 <body>
dan_ackme 34:2616445d0823 27 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
dan_ackme 34:2616445d0823 28 <div id="titlearea" style="font-family:verdana;">
dan_ackme 34:2616445d0823 29 <table border='0' cellpadding='0' cellspacing='0' width="98%">
dan_ackme 34:2616445d0823 30 <tr style="height:20px"><td>&nbsp;</td></tr>
dan_ackme 34:2616445d0823 31 <tr style="border-collapse: collapse; padding: 0;">
dan_ackme 34:2616445d0823 32 <td style="width:20px"></td>
dan_ackme 34:2616445d0823 33 <td style="padding-right:40px"><img src="ackmelogo.png" alt="ACKme Logo" /></td>
dan_ackme 34:2616445d0823 34 <td style="vertical-align:middle; text-align:left; font: bold 25px/100% Verdana, Arial, Helvetica, sans-serif;">
dan_ackme 34:2616445d0823 35 WiConnect Host Library- API Reference Guide</td>
dan_ackme 34:2616445d0823 36 <td style="width:20px"></td>
dan_ackme 34:2616445d0823 37 </tr>
dan_ackme 34:2616445d0823 38 <tr><td>&nbsp;</td></tr>
dan_ackme 34:2616445d0823 39 </table>
dan_ackme 34:2616445d0823 40 </div><!-- Generated by Doxygen 1.8.7 -->
dan_ackme 34:2616445d0823 41 <script type="text/javascript">
dan_ackme 34:2616445d0823 42 var searchBox = new SearchBox("searchBox", "search",false,'Search');
dan_ackme 34:2616445d0823 43 </script>
dan_ackme 34:2616445d0823 44 <div id="navrow1" class="tabs">
dan_ackme 34:2616445d0823 45 <ul class="tablist">
dan_ackme 34:2616445d0823 46 <li><a href="index.html"><span>Library&#160;Overview</span></a></li>
dan_ackme 34:2616445d0823 47 <li><a href="modules.html"><span>Library&#160;API</span></a></li>
dan_ackme 34:2616445d0823 48 <li><a href="examples.html"><span>API&#160;Examples</span></a></li>
dan_ackme 34:2616445d0823 49 <li><a href="annotated.html"><span>Classes</span></a></li>
dan_ackme 34:2616445d0823 50 <li><a href="http://wiconnect.ack.me/2.0/general_overview"><span>WiConnect&#160;Reference&#160;Manual</span></a></li>
dan_ackme 34:2616445d0823 51 <li><a href="http://www.ack.me/WiConnect"><span>ACKme&#160;Website</span></a></li>
dan_ackme 34:2616445d0823 52 <li><a href="http://developer.mbed.org/teams/ACKme/code/WiConnect/"><span>WiConnect&#160;Repository</span></a></li>
dan_ackme 34:2616445d0823 53 <li>
dan_ackme 34:2616445d0823 54 <div id="MSearchBox" class="MSearchBoxInactive">
dan_ackme 34:2616445d0823 55 <span class="left">
dan_ackme 34:2616445d0823 56 <img id="MSearchSelect" src="search/mag_sel.png"
dan_ackme 34:2616445d0823 57 onmouseover="return searchBox.OnSearchSelectShow()"
dan_ackme 34:2616445d0823 58 onmouseout="return searchBox.OnSearchSelectHide()"
dan_ackme 34:2616445d0823 59 alt=""/>
dan_ackme 34:2616445d0823 60 <input type="text" id="MSearchField" value="Search" accesskey="S"
dan_ackme 34:2616445d0823 61 onfocus="searchBox.OnSearchFieldFocus(true)"
dan_ackme 34:2616445d0823 62 onblur="searchBox.OnSearchFieldFocus(false)"
dan_ackme 34:2616445d0823 63 onkeyup="searchBox.OnSearchFieldChange(event)"/>
dan_ackme 34:2616445d0823 64 </span><span class="right">
dan_ackme 34:2616445d0823 65 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
dan_ackme 34:2616445d0823 66 </span>
dan_ackme 34:2616445d0823 67 </div>
dan_ackme 34:2616445d0823 68 </li>
dan_ackme 34:2616445d0823 69 </ul>
dan_ackme 34:2616445d0823 70 </div>
dan_ackme 34:2616445d0823 71 </div><!-- top -->
dan_ackme 34:2616445d0823 72 <div id="side-nav" class="ui-resizable side-nav-resizable">
dan_ackme 34:2616445d0823 73 <div id="nav-tree">
dan_ackme 34:2616445d0823 74 <div id="nav-tree-contents">
dan_ackme 34:2616445d0823 75 <div id="nav-sync" class="sync"></div>
dan_ackme 34:2616445d0823 76 </div>
dan_ackme 34:2616445d0823 77 </div>
dan_ackme 34:2616445d0823 78 <div id="splitbar" style="-moz-user-select:none;"
dan_ackme 34:2616445d0823 79 class="ui-resizable-handle">
dan_ackme 34:2616445d0823 80 </div>
dan_ackme 34:2616445d0823 81 </div>
dan_ackme 34:2616445d0823 82 <script type="text/javascript">
dan_ackme 34:2616445d0823 83 $(document).ready(function(){initNavTree('group__api__socket__udp.html','');});
dan_ackme 34:2616445d0823 84 </script>
dan_ackme 34:2616445d0823 85 <div id="doc-content">
dan_ackme 34:2616445d0823 86 <!-- window showing the filter options -->
dan_ackme 34:2616445d0823 87 <div id="MSearchSelectWindow"
dan_ackme 34:2616445d0823 88 onmouseover="return searchBox.OnSearchSelectShow()"
dan_ackme 34:2616445d0823 89 onmouseout="return searchBox.OnSearchSelectHide()"
dan_ackme 34:2616445d0823 90 onkeydown="return searchBox.OnSearchSelectKey(event)">
dan_ackme 34:2616445d0823 91 <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Pages</a></div>
dan_ackme 34:2616445d0823 92
dan_ackme 34:2616445d0823 93 <!-- iframe showing the search results (closed by default) -->
dan_ackme 34:2616445d0823 94 <div id="MSearchResultsWindow">
dan_ackme 34:2616445d0823 95 <iframe src="javascript:void(0)" frameborder="0"
dan_ackme 34:2616445d0823 96 name="MSearchResults" id="MSearchResults">
dan_ackme 34:2616445d0823 97 </iframe>
dan_ackme 34:2616445d0823 98 </div>
dan_ackme 34:2616445d0823 99
dan_ackme 34:2616445d0823 100 <div class="header">
dan_ackme 34:2616445d0823 101 <div class="summary">
dan_ackme 34:2616445d0823 102 <a href="#func-members">Functions</a> </div>
dan_ackme 34:2616445d0823 103 <div class="headertitle">
dan_ackme 34:2616445d0823 104 <div class="title">UDP Methods<div class="ingroups"><a class="el" href="group__api__socket.html">Socket</a></div></div> </div>
dan_ackme 34:2616445d0823 105 </div><!--header-->
dan_ackme 34:2616445d0823 106 <div class="contents">
dan_ackme 34:2616445d0823 107
dan_ackme 34:2616445d0823 108 <p>UDP methods.
dan_ackme 34:2616445d0823 109 <a href="#details">More...</a></p>
dan_ackme 34:2616445d0823 110 <table class="memberdecls">
dan_ackme 34:2616445d0823 111 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
dan_ackme 34:2616445d0823 112 Functions</h2></td></tr>
dan_ackme 34:2616445d0823 113 <tr class="memitem: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">wiconnect::SocketInterface::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 114 <tr class="memdesc:gac61e0445efcfa48fb98b5b2bc0b77119"><td class="mdescLeft">&#160;</td><td class="mdescRight">Connect to remote UDP server. <a href="#gac61e0445efcfa48fb98b5b2bc0b77119">More...</a><br /></td></tr>
dan_ackme 34:2616445d0823 115 <tr class="separator:gac61e0445efcfa48fb98b5b2bc0b77119"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 34:2616445d0823 116 <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">wiconnect::SocketInterface::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 117 <tr class="memdesc:ga067fb0d662d8e27e3f5b561ded29a51a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start a UDP server listening on the given port. <a href="#ga067fb0d662d8e27e3f5b561ded29a51a">More...</a><br /></td></tr>
dan_ackme 34:2616445d0823 118 <tr class="separator:ga067fb0d662d8e27e3f5b561ded29a51a"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 34:2616445d0823 119 </table>
dan_ackme 34:2616445d0823 120 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
dan_ackme 34:2616445d0823 121 <p>UDP methods. </p>
dan_ackme 34:2616445d0823 122 <h2 class="groupheader">Function Documentation</h2>
dan_ackme 34:2616445d0823 123 <a class="anchor" id="gac61e0445efcfa48fb98b5b2bc0b77119"></a>
dan_ackme 34:2616445d0823 124 <div class="memitem">
dan_ackme 34:2616445d0823 125 <div class="memproto">
dan_ackme 34:2616445d0823 126 <table class="memname">
dan_ackme 34:2616445d0823 127 <tr>
dan_ackme 34:2616445d0823 128 <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::SocketInterface::udpConnect </td>
dan_ackme 34:2616445d0823 129 <td>(</td>
dan_ackme 34:2616445d0823 130 <td class="paramtype"><a class="el" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> &amp;&#160;</td>
dan_ackme 34:2616445d0823 131 <td class="paramname"><em>socket</em>, </td>
dan_ackme 34:2616445d0823 132 </tr>
dan_ackme 34:2616445d0823 133 <tr>
dan_ackme 34:2616445d0823 134 <td class="paramkey"></td>
dan_ackme 34:2616445d0823 135 <td></td>
dan_ackme 34:2616445d0823 136 <td class="paramtype">const char *&#160;</td>
dan_ackme 34:2616445d0823 137 <td class="paramname"><em>host</em>, </td>
dan_ackme 34:2616445d0823 138 </tr>
dan_ackme 34:2616445d0823 139 <tr>
dan_ackme 34:2616445d0823 140 <td class="paramkey"></td>
dan_ackme 34:2616445d0823 141 <td></td>
dan_ackme 34:2616445d0823 142 <td class="paramtype">uint16_t&#160;</td>
dan_ackme 34:2616445d0823 143 <td class="paramname"><em>remortPort</em>, </td>
dan_ackme 34:2616445d0823 144 </tr>
dan_ackme 34:2616445d0823 145 <tr>
dan_ackme 34:2616445d0823 146 <td class="paramkey"></td>
dan_ackme 34:2616445d0823 147 <td></td>
dan_ackme 34:2616445d0823 148 <td class="paramtype">uint16_t&#160;</td>
dan_ackme 34:2616445d0823 149 <td class="paramname"><em>localPort</em> = <code><a class="el" href="group__api__socket__macro.html#gae54117ebe433295ef992b9ca83c46d98">SOCKET_ANY_PORT</a></code>&#160;</td>
dan_ackme 34:2616445d0823 150 </tr>
dan_ackme 34:2616445d0823 151 <tr>
dan_ackme 34:2616445d0823 152 <td></td>
dan_ackme 34:2616445d0823 153 <td>)</td>
dan_ackme 34:2616445d0823 154 <td></td><td></td>
dan_ackme 34:2616445d0823 155 </tr>
dan_ackme 34:2616445d0823 156 </table>
dan_ackme 34:2616445d0823 157 </div><div class="memdoc">
dan_ackme 34:2616445d0823 158
dan_ackme 34:2616445d0823 159 <p>Connect to remote UDP server. </p>
dan_ackme 34:2616445d0823 160 <dl class="params"><dt>Parameters</dt><dd>
dan_ackme 34:2616445d0823 161 <table class="params">
dan_ackme 34:2616445d0823 162 <tr><td class="paramdir">[out]</td><td class="paramname">socket</td><td>UDP <a class="el" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> object of opened connection. </td></tr>
dan_ackme 34:2616445d0823 163 <tr><td class="paramdir">[in]</td><td class="paramname">host</td><td>The host/IP address of the remote UDP server </td></tr>
dan_ackme 34:2616445d0823 164 <tr><td class="paramdir">[in]</td><td class="paramname">remortPort</td><td>The port of the remote server </td></tr>
dan_ackme 34:2616445d0823 165 <tr><td class="paramdir">[in]</td><td class="paramname">localPort</td><td>Optional, port of module's side of the connection </td></tr>
dan_ackme 34:2616445d0823 166 <tr><td class="paramdir">[in]</td><td class="paramname">irqPin</td><td>Optional, Data available external interrupt pin. See registerSocketIrqHandler() for more info </td></tr>
dan_ackme 34:2616445d0823 167 </table>
dan_ackme 34:2616445d0823 168 </dd>
dan_ackme 34:2616445d0823 169 </dl>
dan_ackme 34:2616445d0823 170 <dl class="section return"><dt>Returns</dt><dd>Result of method. See <a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </dd></dl>
dan_ackme 34:2616445d0823 171
dan_ackme 34:2616445d0823 172 </div>
dan_ackme 34:2616445d0823 173 </div>
dan_ackme 34:2616445d0823 174 <a class="anchor" id="ga067fb0d662d8e27e3f5b561ded29a51a"></a>
dan_ackme 34:2616445d0823 175 <div class="memitem">
dan_ackme 34:2616445d0823 176 <div class="memproto">
dan_ackme 34:2616445d0823 177 <table class="memname">
dan_ackme 34:2616445d0823 178 <tr>
dan_ackme 34:2616445d0823 179 <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::SocketInterface::udpListen </td>
dan_ackme 34:2616445d0823 180 <td>(</td>
dan_ackme 34:2616445d0823 181 <td class="paramtype"><a class="el" href="classwiconnect_1_1_wiconnect_udp_server.html">WiconnectUdpServer</a> &amp;&#160;</td>
dan_ackme 34:2616445d0823 182 <td class="paramname"><em>udpServer</em>, </td>
dan_ackme 34:2616445d0823 183 </tr>
dan_ackme 34:2616445d0823 184 <tr>
dan_ackme 34:2616445d0823 185 <td class="paramkey"></td>
dan_ackme 34:2616445d0823 186 <td></td>
dan_ackme 34:2616445d0823 187 <td class="paramtype">uint16_t&#160;</td>
dan_ackme 34:2616445d0823 188 <td class="paramname"><em>listeningPort</em>&#160;</td>
dan_ackme 34:2616445d0823 189 </tr>
dan_ackme 34:2616445d0823 190 <tr>
dan_ackme 34:2616445d0823 191 <td></td>
dan_ackme 34:2616445d0823 192 <td>)</td>
dan_ackme 34:2616445d0823 193 <td></td><td></td>
dan_ackme 34:2616445d0823 194 </tr>
dan_ackme 34:2616445d0823 195 </table>
dan_ackme 34:2616445d0823 196 </div><div class="memdoc">
dan_ackme 34:2616445d0823 197
dan_ackme 34:2616445d0823 198 <p>Start a UDP server listening on the given port. </p>
dan_ackme 34:2616445d0823 199 <dl class="params"><dt>Parameters</dt><dd>
dan_ackme 34:2616445d0823 200 <table class="params">
dan_ackme 34:2616445d0823 201 <tr><td class="paramdir">[out]</td><td class="paramname">udpServer</td><td>UDP <a class="el" href="classwiconnect_1_1_wiconnect_udp_server.html">WiconnectUdpServer</a> object listening server </td></tr>
dan_ackme 34:2616445d0823 202 <tr><td class="paramdir">[in]</td><td class="paramname">listeningPort</td><td>The port the UDP server listens on </td></tr>
dan_ackme 34:2616445d0823 203 </table>
dan_ackme 34:2616445d0823 204 </dd>
dan_ackme 34:2616445d0823 205 </dl>
dan_ackme 34:2616445d0823 206 <dl class="section return"><dt>Returns</dt><dd>Result of method. See <a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </dd></dl>
dan_ackme 34:2616445d0823 207
dan_ackme 34:2616445d0823 208 </div>
dan_ackme 34:2616445d0823 209 </div>
dan_ackme 34:2616445d0823 210 </div><!-- contents -->
dan_ackme 34:2616445d0823 211 </div><!-- doc-content -->
dan_ackme 34:2616445d0823 212 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
dan_ackme 34:2616445d0823 213 <ul>
dan_ackme 34:2616445d0823 214 <li class="footer">&copy; ACKme Networks 2014</li>
dan_ackme 34:2616445d0823 215 </ul>
dan_ackme 34:2616445d0823 216 </div>
dan_ackme 34:2616445d0823 217 </body>
dan_ackme 34:2616445d0823 218 </html>