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/_wiconnect_socket_8h_source.html@26:8067e3d463d3, 2014-10-23 (annotated)

Committer:
dan_ackme
Date:
Thu Oct 23 15:16:06 2014 -0700
Revision:
26:8067e3d463d3
Parent:
21:17bb3eddcbae
Child:
29:b6af04b77a56
Added 'updateFirmware' and 'networkGetJoinResult' api methods

Various bug fixes

Updated documentation

Who changed what in which revision?

UserRevisionLine numberNew contents of line
dan_ackme 17:7268f365676b 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
dan_ackme 17:7268f365676b 2 <html xmlns="http://www.w3.org/1999/xhtml">
dan_ackme 17:7268f365676b 3 <head>
dan_ackme 17:7268f365676b 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
dan_ackme 17:7268f365676b 5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
dan_ackme 17:7268f365676b 6 <title>ACKme WiConnect Host Library</title>
dan_ackme 17:7268f365676b 7 <link rel="icon" href="favicon.ico" type="image/x-icon">
dan_ackme 17:7268f365676b 8 <link rel="shortcut icon" href="favicon.ico" type="image/x-icon">
dan_ackme 17:7268f365676b 9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
dan_ackme 17:7268f365676b 10 <script type="text/javascript" src="jquery.js"></script>
dan_ackme 17:7268f365676b 11 <script type="text/javascript" src="dynsections.js"></script>
dan_ackme 17:7268f365676b 12 <link href="navtree.css" rel="stylesheet" type="text/css"/>
dan_ackme 17:7268f365676b 13 <script type="text/javascript" src="resize.js"></script>
dan_ackme 17:7268f365676b 14 <script type="text/javascript" src="navtree.js"></script>
dan_ackme 17:7268f365676b 15 <script type="text/javascript">
dan_ackme 17:7268f365676b 16 $(document).ready(initResizable);
dan_ackme 17:7268f365676b 17 $(window).load(resizeHeight);
dan_ackme 17:7268f365676b 18 </script>
dan_ackme 17:7268f365676b 19 <link href="search/search.css" rel="stylesheet" type="text/css"/>
dan_ackme 17:7268f365676b 20 <script type="text/javascript" src="search/search.js"></script>
dan_ackme 17:7268f365676b 21 <script type="text/javascript">
dan_ackme 17:7268f365676b 22 $(document).ready(function() { searchBox.OnSelectItem(0); });
dan_ackme 17:7268f365676b 23 </script>
dan_ackme 17:7268f365676b 24 <link href="doxygen.css" rel="stylesheet" type="text/css" />
dan_ackme 17:7268f365676b 25 </head>
dan_ackme 17:7268f365676b 26 <body>
dan_ackme 17:7268f365676b 27 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
dan_ackme 17:7268f365676b 28 <div id="titlearea" style="font-family:verdana;">
dan_ackme 17:7268f365676b 29 <table border='0' cellpadding='0' cellspacing='0' width="98%">
dan_ackme 17:7268f365676b 30 <tr style="height:20px"><td>&nbsp;</td></tr>
dan_ackme 17:7268f365676b 31 <tr style="border-collapse: collapse; padding: 0;">
dan_ackme 17:7268f365676b 32 <td style="width:20px"></td>
dan_ackme 17:7268f365676b 33 <td style="padding-right:40px"><img src="ackmelogo.png" alt="ACKme Logo" /></td>
dan_ackme 17:7268f365676b 34 <td style="vertical-align:middle; text-align:left; font: bold 25px/100% Verdana, Arial, Helvetica, sans-serif;">
dan_ackme 17:7268f365676b 35 WiConnect Host Library- API Reference Guide</td>
dan_ackme 17:7268f365676b 36 <td style="width:20px"></td>
dan_ackme 17:7268f365676b 37 </tr>
dan_ackme 17:7268f365676b 38 <tr><td>&nbsp;</td></tr>
dan_ackme 17:7268f365676b 39 </table>
dan_ackme 17:7268f365676b 40 </div><!-- Generated by Doxygen 1.8.7 -->
dan_ackme 17:7268f365676b 41 <script type="text/javascript">
dan_ackme 17:7268f365676b 42 var searchBox = new SearchBox("searchBox", "search",false,'Search');
dan_ackme 17:7268f365676b 43 </script>
dan_ackme 17:7268f365676b 44 <div id="navrow1" class="tabs">
dan_ackme 17:7268f365676b 45 <ul class="tablist">
dan_ackme 17:7268f365676b 46 <li><a href="index.html"><span>Library&#160;Overview</span></a></li>
dan_ackme 17:7268f365676b 47 <li><a href="modules.html"><span>Library&#160;API</span></a></li>
dan_ackme 17:7268f365676b 48 <li><a href="examples.html"><span>API&#160;Examples</span></a></li>
dan_ackme 17:7268f365676b 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 17:7268f365676b 51 <li><a href="http://www.ack.me/WiConnect"><span>ACKme&#160;Website</span></a></li>
dan_ackme 17:7268f365676b 52 <li>
dan_ackme 17:7268f365676b 53 <div id="MSearchBox" class="MSearchBoxInactive">
dan_ackme 17:7268f365676b 54 <span class="left">
dan_ackme 17:7268f365676b 55 <img id="MSearchSelect" src="search/mag_sel.png"
dan_ackme 17:7268f365676b 56 onmouseover="return searchBox.OnSearchSelectShow()"
dan_ackme 17:7268f365676b 57 onmouseout="return searchBox.OnSearchSelectHide()"
dan_ackme 17:7268f365676b 58 alt=""/>
dan_ackme 17:7268f365676b 59 <input type="text" id="MSearchField" value="Search" accesskey="S"
dan_ackme 17:7268f365676b 60 onfocus="searchBox.OnSearchFieldFocus(true)"
dan_ackme 17:7268f365676b 61 onblur="searchBox.OnSearchFieldFocus(false)"
dan_ackme 17:7268f365676b 62 onkeyup="searchBox.OnSearchFieldChange(event)"/>
dan_ackme 17:7268f365676b 63 </span><span class="right">
dan_ackme 17:7268f365676b 64 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
dan_ackme 17:7268f365676b 65 </span>
dan_ackme 17:7268f365676b 66 </div>
dan_ackme 17:7268f365676b 67 </li>
dan_ackme 17:7268f365676b 68 </ul>
dan_ackme 17:7268f365676b 69 </div>
dan_ackme 17:7268f365676b 70 </div><!-- top -->
dan_ackme 17:7268f365676b 71 <div id="side-nav" class="ui-resizable side-nav-resizable">
dan_ackme 17:7268f365676b 72 <div id="nav-tree">
dan_ackme 17:7268f365676b 73 <div id="nav-tree-contents">
dan_ackme 17:7268f365676b 74 <div id="nav-sync" class="sync"></div>
dan_ackme 17:7268f365676b 75 </div>
dan_ackme 17:7268f365676b 76 </div>
dan_ackme 17:7268f365676b 77 <div id="splitbar" style="-moz-user-select:none;"
dan_ackme 17:7268f365676b 78 class="ui-resizable-handle">
dan_ackme 17:7268f365676b 79 </div>
dan_ackme 17:7268f365676b 80 </div>
dan_ackme 17:7268f365676b 81 <script type="text/javascript">
dan_ackme 17:7268f365676b 82 $(document).ready(function(){initNavTree('_wiconnect_socket_8h_source.html','');});
dan_ackme 17:7268f365676b 83 </script>
dan_ackme 17:7268f365676b 84 <div id="doc-content">
dan_ackme 17:7268f365676b 85 <!-- window showing the filter options -->
dan_ackme 17:7268f365676b 86 <div id="MSearchSelectWindow"
dan_ackme 17:7268f365676b 87 onmouseover="return searchBox.OnSearchSelectShow()"
dan_ackme 17:7268f365676b 88 onmouseout="return searchBox.OnSearchSelectHide()"
dan_ackme 17:7268f365676b 89 onkeydown="return searchBox.OnSearchSelectKey(event)">
dan_ackme 17:7268f365676b 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 17:7268f365676b 91
dan_ackme 17:7268f365676b 92 <!-- iframe showing the search results (closed by default) -->
dan_ackme 17:7268f365676b 93 <div id="MSearchResultsWindow">
dan_ackme 17:7268f365676b 94 <iframe src="javascript:void(0)" frameborder="0"
dan_ackme 17:7268f365676b 95 name="MSearchResults" id="MSearchResults">
dan_ackme 17:7268f365676b 96 </iframe>
dan_ackme 17:7268f365676b 97 </div>
dan_ackme 17:7268f365676b 98
dan_ackme 17:7268f365676b 99 <div class="header">
dan_ackme 17:7268f365676b 100 <div class="headertitle">
dan_ackme 17:7268f365676b 101 <div class="title">WiconnectSocket.h</div> </div>
dan_ackme 17:7268f365676b 102 </div><!--header-->
dan_ackme 17:7268f365676b 103 <div class="contents">
dan_ackme 17:7268f365676b 104 <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;</div>
dan_ackme 17:7268f365676b 105 <div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor">#pragma once</span></div>
dan_ackme 17:7268f365676b 106 <div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;</div>
dan_ackme 17:7268f365676b 107 <div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;</div>
dan_ackme 17:7268f365676b 108 <div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="preprocessor">#include &quot;WiconnectTypes.h&quot;</span></div>
dan_ackme 17:7268f365676b 109 <div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;</div>
dan_ackme 17:7268f365676b 110 <div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="keyword">namespace </span>wiconnect</div>
dan_ackme 17:7268f365676b 111 <div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;{</div>
dan_ackme 17:7268f365676b 112 <div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;</div>
dan_ackme 17:7268f365676b 113 <div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="classwiconnect_1_1_wiconnect_socket.html"> 43</a></span>&#160;<span class="keyword">class </span><a class="code" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a></div>
dan_ackme 17:7268f365676b 114 <div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;{</div>
dan_ackme 17:7268f365676b 115 <div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<span class="keyword">public</span>:</div>
dan_ackme 17:7268f365676b 116 <div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <a class="code" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</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>
dan_ackme 17:7268f365676b 117 <div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; ~<a class="code" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a>();</div>
dan_ackme 17:7268f365676b 118 <div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;</div>
dan_ackme 17:7268f365676b 119 <div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> close();</div>
dan_ackme 17:7268f365676b 120 <div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> poll(<span class="keywordtype">bool</span> *rxDataAvailablePtr, <span class="keywordtype">bool</span> autoClose = <span class="keyword">false</span>);</div>
dan_ackme 21:17bb3eddcbae 121 <div class="line"><a name="l00051"></a><span class="lineno"> 51</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">true</span>);</div>
dan_ackme 17:7268f365676b 122 <div class="line"><a name="l00052"></a><span class="lineno"> 52</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>
dan_ackme 17:7268f365676b 123 <div class="line"><a name="l00053"></a><span class="lineno"> 53</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>
dan_ackme 17:7268f365676b 124 <div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> read(uint8_t **bufferPtr = NULL, uint16_t *bytesReadPtr = NULL);</div>
dan_ackme 17:7268f365676b 125 <div class="line"><a name="l00055"></a><span class="lineno"> 55</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>
dan_ackme 21:17bb3eddcbae 126 <div class="line"><a name="l00056"></a><span class="lineno"> 56</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">true</span>);</div>
dan_ackme 17:7268f365676b 127 <div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> getc(uint8_t *c);</div>
dan_ackme 17:7268f365676b 128 <div class="line"><a name="l00058"></a><span class="lineno"> 58</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>
dan_ackme 17:7268f365676b 129 <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> flushTxBuffer();</div>
dan_ackme 17:7268f365676b 130 <div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <span class="keywordtype">void</span> clearRxBuffer();</div>
dan_ackme 17:7268f365676b 131 <div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;</div>
dan_ackme 17:7268f365676b 132 <div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; uint8_t *getTxBuffer();</div>
dan_ackme 17:7268f365676b 133 <div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <span class="keywordtype">int</span> getTxBufferSize();</div>
dan_ackme 17:7268f365676b 134 <div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; <span class="keywordtype">int</span> getTxBufferBytesPending();</div>
dan_ackme 17:7268f365676b 135 <div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; uint8_t *getRxBuffer();</div>
dan_ackme 17:7268f365676b 136 <div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <span class="keywordtype">int</span> getRxBufferSize();</div>
dan_ackme 17:7268f365676b 137 <div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <span class="keywordtype">int</span> getRxBufferBytesPending();</div>
dan_ackme 17:7268f365676b 138 <div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;</div>
dan_ackme 17:7268f365676b 139 <div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <span class="keywordtype">bool</span> isConnected();</div>
dan_ackme 17:7268f365676b 140 <div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <a class="code" href="group__api__socket__types.html#ga69dc55558df4c81599c5fb3dff98756d">SocketType</a> getType();</div>
dan_ackme 17:7268f365676b 141 <div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span>* getHost();</div>
dan_ackme 17:7268f365676b 142 <div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; uint16_t getLocalPort();</div>
dan_ackme 17:7268f365676b 143 <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; uint16_t getRemotePort();</div>
dan_ackme 17:7268f365676b 144 <div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; uint8_t getHandle();</div>
dan_ackme 17:7268f365676b 145 <div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160;</div>
dan_ackme 17:7268f365676b 146 <div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160;<span class="keyword">protected</span>:</div>
dan_ackme 17:7268f365676b 147 <div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; <span class="keywordtype">bool</span> connected;</div>
dan_ackme 17:7268f365676b 148 <div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; <a class="code" href="group__api__socket__types.html#ga69dc55558df4c81599c5fb3dff98756d">SocketType</a> type;</div>
dan_ackme 17:7268f365676b 149 <div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; uint8_t handle;</div>
dan_ackme 17:7268f365676b 150 <div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; <span class="keywordtype">char</span> host[<a class="code" href="group__api__core__macro.html#ga7c5dcedd35669199b46bb292b3d3b525">WICONNECT_MAX_HOST_SIZE</a>];</div>
dan_ackme 17:7268f365676b 151 <div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; uint16_t localPort;</div>
dan_ackme 17:7268f365676b 152 <div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; uint16_t remotePort;</div>
dan_ackme 17:7268f365676b 153 <div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; <a class="code" href="classwiconnect_1_1_wiconnect.html">Wiconnect</a> *wiconnect;</div>
dan_ackme 17:7268f365676b 154 <div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; Buffer txBuffer;</div>
dan_ackme 17:7268f365676b 155 <div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; Buffer rxBuffer;</div>
dan_ackme 17:7268f365676b 156 <div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160;</div>
dan_ackme 17:7268f365676b 157 <div class="line"><a name="l00087"></a><span class="lineno"> 87</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>
dan_ackme 17:7268f365676b 158 <div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160;</div>
dan_ackme 17:7268f365676b 159 <div class="line"><a name="l00089"></a><span class="lineno"> 89</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>
dan_ackme 17:7268f365676b 160 <div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160;</div>
dan_ackme 17:7268f365676b 161 <div class="line"><a name="l00091"></a><span class="lineno"> 91</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>
dan_ackme 17:7268f365676b 162 <div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160;};</div>
dan_ackme 17:7268f365676b 163 <div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160;</div>
dan_ackme 17:7268f365676b 164 <div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160;</div>
dan_ackme 17:7268f365676b 165 <div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160;}</div>
dan_ackme 26:8067e3d463d3 166 <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#l00324">WiconnectTypes.h:324</a></div></div>
dan_ackme 26:8067e3d463d3 167 <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#l00159">WiconnectTypes.h:159</a></div></div>
dan_ackme 17:7268f365676b 168 <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#l00121">WiconnectTypes.h:121</a></div></div>
dan_ackme 17:7268f365676b 169 <div class="ttc" id="classwiconnect_1_1_wiconnect_socket_html"><div class="ttname"><a href="classwiconnect_1_1_wiconnect_socket.html">wiconnect::WiconnectSocket</a></div><div class="ttdoc">Connection object to remote server. </div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_socket_8h_source.html#l00043">WiconnectSocket.h:43</a></div></div>
dan_ackme 17:7268f365676b 170 <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#l00051">SocketInterface.h:51</a></div></div>
dan_ackme 17:7268f365676b 171 <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#l00074">WiconnectInterface.h:74</a></div></div>
dan_ackme 17:7268f365676b 172 </div><!-- fragment --></div><!-- contents -->
dan_ackme 17:7268f365676b 173 </div><!-- doc-content -->
dan_ackme 17:7268f365676b 174 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
dan_ackme 17:7268f365676b 175 <ul>
dan_ackme 17:7268f365676b 176 <li class="footer">&copy; ACKme Networks 2014</li>
dan_ackme 17:7268f365676b 177 </ul>
dan_ackme 17:7268f365676b 178 </div>
dan_ackme 17:7268f365676b 179 </body>
dan_ackme 17:7268f365676b 180 </html>