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

Diff: doc/html/_socket_8h_source.html

Revision:
14:85a2ed029f37
Child:
16:7f1d6d359787
diff -r 2b51f5267c92 -r 85a2ed029f37 doc/html/_socket_8h_source.html
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/html/_socket_8h_source.html	Wed Aug 13 03:14:43 2014 -0700
@@ -0,0 +1,189 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
+<meta http-equiv="X-UA-Compatible" content="IE=9"/>
+<title>ACKme WiConnect Host Library</title>
+<link rel="icon" href="favicon.ico" type="image/x-icon">
+<link rel="shortcut icon" href="favicon.ico" type="image/x-icon">
+<link href="tabs.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="jquery.js"></script>
+<script type="text/javascript" src="dynsections.js"></script>
+<link href="navtree.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="resize.js"></script>
+<script type="text/javascript" src="navtree.js"></script>
+<script type="text/javascript">
+  $(document).ready(initResizable);
+  $(window).load(resizeHeight);
+</script>
+<link href="search/search.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="search/search.js"></script>
+<script type="text/javascript">
+  $(document).ready(function() { searchBox.OnSelectItem(0); });
+</script>
+<link href="doxygen.css" rel="stylesheet" type="text/css" />
+</head>
+<body>
+<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
+<div id="titlearea" style="font-family:verdana;">
+    <table border='0' cellpadding='0' cellspacing='0' width="98%">
+      <tr style="height:20px"><td>&nbsp;</td></tr>
+      <tr style="border-collapse: collapse; padding: 0;">
+        <td style="width:20px"></td>
+        <td style="padding-right:40px"><img src="ackmelogo.png" alt="ACKme Logo" /></td>
+        <td style="vertical-align:middle; text-align:left; font: bold 25px/100% Verdana, Arial, Helvetica, sans-serif;">
+        WiConnect Host Library- API Reference Guide</td>
+        <td style="width:20px"></td>
+      </tr>
+      <tr><td>&nbsp;</td></tr>
+    </table>
+</div><!-- Generated by Doxygen 1.8.7 -->
+<script type="text/javascript">
+var searchBox = new SearchBox("searchBox", "search",false,'Search');
+</script>
+  <div id="navrow1" class="tabs">
+    <ul class="tablist">
+      <li><a href="index.html"><span>Library&#160;Overview</span></a></li>
+      <li><a href="modules.html"><span>Library&#160;API</span></a></li>
+      <li><a href="examples.html"><span>API&#160;Examples</span></a></li>
+      <li><a href="annotated.html"><span>Classes</span></a></li>
+      <li><a href="http://wiconnect.ack.me/1.2/general_overview"><span>WiConnect&#160;Reference&#160;Manual</span></a></li>
+      <li><a href="http://www.ack.me/WiConnect"><span>ACKme&#160;Website</span></a></li>
+      <li>
+        <div id="MSearchBox" class="MSearchBoxInactive">
+        <span class="left">
+          <img id="MSearchSelect" src="search/mag_sel.png"
+               onmouseover="return searchBox.OnSearchSelectShow()"
+               onmouseout="return searchBox.OnSearchSelectHide()"
+               alt=""/>
+          <input type="text" id="MSearchField" value="Search" accesskey="S"
+               onfocus="searchBox.OnSearchFieldFocus(true)" 
+               onblur="searchBox.OnSearchFieldFocus(false)" 
+               onkeyup="searchBox.OnSearchFieldChange(event)"/>
+          </span><span class="right">
+            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
+          </span>
+        </div>
+      </li>
+    </ul>
+  </div>
+</div><!-- top -->
+<div id="side-nav" class="ui-resizable side-nav-resizable">
+  <div id="nav-tree">
+    <div id="nav-tree-contents">
+      <div id="nav-sync" class="sync"></div>
+    </div>
+  </div>
+  <div id="splitbar" style="-moz-user-select:none;" 
+       class="ui-resizable-handle">
+  </div>
+</div>
+<script type="text/javascript">
+$(document).ready(function(){initNavTree('_socket_8h_source.html','');});
+</script>
+<div id="doc-content">
+<!-- window showing the filter options -->
+<div id="MSearchSelectWindow"
+     onmouseover="return searchBox.OnSearchSelectShow()"
+     onmouseout="return searchBox.OnSearchSelectHide()"
+     onkeydown="return searchBox.OnSearchSelectKey(event)">
+<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>
+
+<!-- iframe showing the search results (closed by default) -->
+<div id="MSearchResultsWindow">
+<iframe src="javascript:void(0)" frameborder="0" 
+        name="MSearchResults" id="MSearchResults">
+</iframe>
+</div>
+
+<div class="header">
+  <div class="headertitle">
+<div class="title">Socket.h</div>  </div>
+</div><!--header-->
+<div class="contents">
+<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/*</span></div>
+<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> * Copyright 2014, ACKme Networks</span></div>
+<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> * All Rights Reserved.</span></div>
+<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> *</span></div>
+<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> * This is UNPUBLISHED PROPRIETARY SOURCE CODE of ACKme Networks;</span></div>
+<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> * the contents of this file may not be disclosed to third parties, copied</span></div>
+<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> * or duplicated in any form, in whole or in part, without the prior</span></div>
+<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> * written permission of ACKme Networks.</span></div>
+<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"> */</span></div>
+<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;</div>
+<div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="preprocessor">#pragma once</span></div>
+<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;</div>
+<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;</div>
+<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="preprocessor">#include &quot;WiconnectTypes.h&quot;</span></div>
+<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;</div>
+<div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="keyword">namespace </span>wiconnect</div>
+<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;{</div>
+<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;</div>
+<div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="classwiconnect_1_1_socket.html">   25</a></span>&#160;<span class="keyword">class </span><a class="code" href="classwiconnect_1_1_socket.html">Socket</a></div>
+<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;{</div>
+<div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="keyword">public</span>:</div>
+<div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;    <a class="code" href="classwiconnect_1_1_socket.html">Socket</a>(<span class="keywordtype">int</span> rxBufferLen = 0, <span class="keywordtype">void</span> *rxBuffer = NULL, <span class="keywordtype">int</span> txBufferLen = 0, <span class="keywordtype">void</span> *txBuffer = NULL);</div>
+<div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;    ~<a class="code" href="classwiconnect_1_1_socket.html">Socket</a>();</div>
+<div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;</div>
+<div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;    <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> close();</div>
+<div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;    <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> poll(<span class="keywordtype">bool</span> *rxDataAvailablePtr);</div>
+<div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;    <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> write(<span class="keyword">const</span> <span class="keywordtype">void</span>* buffer, <span class="keywordtype">int</span> length, <span class="keywordtype">bool</span> flush = <span class="keyword">false</span>);</div>
+<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;    <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> write(<span class="keywordtype">int</span> length, <span class="keywordtype">bool</span> flush = <span class="keyword">true</span>);</div>
+<div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;    <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> read(<span class="keywordtype">void</span>* buffer, uint16_t maxLength, uint16_t *bytesRead);</div>
+<div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;    <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> read(uint8_t **bufferPtr = NULL, uint16_t *bytesReadPtr = NULL);</div>
+<div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;    <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> putc(uint8_t c, <span class="keywordtype">bool</span> flush = <span class="keyword">false</span>);</div>
+<div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;    <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> puts(<span class="keyword">const</span> <span class="keywordtype">char</span> *s, <span class="keywordtype">bool</span> flush = <span class="keyword">false</span>);</div>
+<div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;    <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> getc(uint8_t *c);</div>
+<div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;    <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> printf(<span class="keyword">const</span> <span class="keywordtype">char</span>* format, ...);</div>
+<div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;    <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> flushTxBuffer();</div>
+<div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;    <span class="keywordtype">void</span> clearRxBuffer();</div>
+<div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;</div>
+<div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;    uint8_t *getTxBuffer();</div>
+<div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;    <span class="keywordtype">int</span> getTxBufferSize();</div>
+<div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;    <span class="keywordtype">int</span> getTxBufferBytesPending();</div>
+<div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;    uint8_t *getRxBuffer();</div>
+<div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;    <span class="keywordtype">int</span> getRxBufferSize();</div>
+<div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;    <span class="keywordtype">int</span> getRxBufferBytesPending();</div>
+<div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;</div>
+<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;    <span class="keywordtype">bool</span> isConnected();</div>
+<div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;    <a class="code" href="group__api__socket__types.html#ga69dc55558df4c81599c5fb3dff98756d">SocketType</a> getType();</div>
+<div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;    <span class="keyword">const</span> <span class="keywordtype">char</span>* getHost();</div>
+<div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;    uint16_t getLocalPort();</div>
+<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;    uint16_t getRemotePort();</div>
+<div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;    uint8_t getHandle();</div>
+<div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;</div>
+<div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;<span class="keyword">protected</span>:</div>
+<div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;    <span class="keywordtype">bool</span> connected;</div>
+<div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;    <a class="code" href="group__api__socket__types.html#ga69dc55558df4c81599c5fb3dff98756d">SocketType</a> type;</div>
+<div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;    uint8_t handle;</div>
+<div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;    <span class="keywordtype">char</span> host[<a class="code" href="group__api__core__macro.html#ga7c5dcedd35669199b46bb292b3d3b525">WICONNECT_MAX_HOST_SIZE</a>];</div>
+<div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;    uint16_t localPort;</div>
+<div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;    uint16_t remotePort;</div>
+<div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;    <a class="code" href="classwiconnect_1_1_wiconnect.html">Wiconnect</a> *wiconnect;</div>
+<div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;    Buffer txBuffer;</div>
+<div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;    Buffer rxBuffer;</div>
+<div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;</div>
+<div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;    <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> init(uint8_t handle, <a class="code" href="group__api__socket__types.html#ga69dc55558df4c81599c5fb3dff98756d">SocketType</a> type, <span class="keyword">const</span> <span class="keywordtype">char</span> *host, uint16_t remotePort, uint16_t localPort);</div>
+<div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;</div>
+<div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;    <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> writeDataCallback(<span class="keywordtype">void</span> *user, <span class="keywordtype">void</span> *data, <span class="keywordtype">int</span> maxReadSize, <span class="keywordtype">int</span> *bytesRead);</div>
+<div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;</div>
+<div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;    <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classwiconnect_1_1_socket_interface.html">SocketInterface</a>;</div>
+<div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;};</div>
+<div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;</div>
+<div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;</div>
+<div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;}</div>
+<div class="ttc" id="group__api__socket__types_html_ga69dc55558df4c81599c5fb3dff98756d"><div class="ttname"><a href="group__api__socket__types.html#ga69dc55558df4c81599c5fb3dff98756d">wiconnect::SocketType</a></div><div class="ttdeci">SocketType</div><div class="ttdoc">Socket type. </div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_types_8h_source.html#l00274">WiconnectTypes.h:274</a></div></div>
+<div class="ttc" id="group__api__core__types_html_ga325637ed501728bd6c8c7a7982b9ce05"><div class="ttname"><a href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">wiconnect::WiconnectResult</a></div><div class="ttdeci">WiconnectResult</div><div class="ttdoc">API Result code. </div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_types_8h_source.html#l00127">WiconnectTypes.h:127</a></div></div>
+<div class="ttc" id="group__api__core__macro_html_ga7c5dcedd35669199b46bb292b3d3b525"><div class="ttname"><a href="group__api__core__macro.html#ga7c5dcedd35669199b46bb292b3d3b525">WICONNECT_MAX_HOST_SIZE</a></div><div class="ttdeci">#define WICONNECT_MAX_HOST_SIZE</div><div class="ttdoc">The maximum server string length. </div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_types_8h_source.html#l00102">WiconnectTypes.h:102</a></div></div>
+<div class="ttc" id="classwiconnect_1_1_socket_html"><div class="ttname"><a href="classwiconnect_1_1_socket.html">wiconnect::Socket</a></div><div class="ttdoc">Connection object to remote server. </div><div class="ttdef"><b>Definition:</b> <a href="_socket_8h_source.html#l00025">Socket.h:25</a></div></div>
+<div class="ttc" id="classwiconnect_1_1_socket_interface_html"><div class="ttname"><a href="classwiconnect_1_1_socket_interface.html">wiconnect::SocketInterface</a></div><div class="ttdoc">The provides an interface for creating TCP/UDP/TLS/HTTP client sockets. A client socket connects to a...</div><div class="ttdef"><b>Definition:</b> <a href="_socket_interface_8h_source.html#l00033">SocketInterface.h:33</a></div></div>
+<div class="ttc" id="classwiconnect_1_1_wiconnect_html"><div class="ttname"><a href="classwiconnect_1_1_wiconnect.html">wiconnect::Wiconnect</a></div><div class="ttdoc">The root WiConnect library class. This class inheriets all WiConnect functionality. </div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_interface_8h_source.html#l00056">WiconnectInterface.h:56</a></div></div>
+</div><!-- fragment --></div><!-- contents -->
+</div><!-- doc-content -->
+<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
+  <ul>
+    <li class="footer">&copy; ACKme Networks 2014</li>
+  </ul>
+</div>
+</body>
+</html>
\ No newline at end of file