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
- Committer:
- dan_ackme
- Date:
- 2014-08-23
- Revision:
- 17:7268f365676b
- Child:
- 21:17bb3eddcbae
File content as of revision 17:7268f365676b:
<!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> </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> </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 Overview</span></a></li> <li><a href="modules.html"><span>Library API</span></a></li> <li><a href="examples.html"><span>API 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 Reference Manual</span></a></li> <li><a href="http://www.ack.me/WiConnect"><span>ACKme 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('_wiconnect_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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </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">WiconnectSocket.h</div> </div> </div><!--header--> <div class="contents"> <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> </div> <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#pragma once</span></div> <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div> <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div> <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include "WiconnectTypes.h"</span></div> <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div> <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">namespace </span>wiconnect</div> <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> {</div> <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div> <div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="classwiconnect_1_1_wiconnect_socket.html"> 43</a></span> <span class="keyword">class </span><a class="code" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a></div> <div class="line"><a name="l00044"></a><span class="lineno"> 44</span> {</div> <div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="keyword">public</span>:</div> <div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <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> <div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  ~<a class="code" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a>();</div> <div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div> <div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> close();</div> <div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <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> <div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <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="l00052"></a><span class="lineno"> 52</span>  <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="l00053"></a><span class="lineno"> 53</span>  <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="l00054"></a><span class="lineno"> 54</span>  <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="l00055"></a><span class="lineno"> 55</span>  <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="l00056"></a><span class="lineno"> 56</span>  <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="l00057"></a><span class="lineno"> 57</span>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> getc(uint8_t *c);</div> <div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <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="l00059"></a><span class="lineno"> 59</span>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> flushTxBuffer();</div> <div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keywordtype">void</span> clearRxBuffer();</div> <div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div> <div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  uint8_t *getTxBuffer();</div> <div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keywordtype">int</span> getTxBufferSize();</div> <div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keywordtype">int</span> getTxBufferBytesPending();</div> <div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  uint8_t *getRxBuffer();</div> <div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keywordtype">int</span> getRxBufferSize();</div> <div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keywordtype">int</span> getRxBufferBytesPending();</div> <div class="line"><a name="l00068"></a><span class="lineno"> 68</span> </div> <div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keywordtype">bool</span> isConnected();</div> <div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <a class="code" href="group__api__socket__types.html#ga69dc55558df4c81599c5fb3dff98756d">SocketType</a> getType();</div> <div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* getHost();</div> <div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  uint16_t getLocalPort();</div> <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  uint16_t getRemotePort();</div> <div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  uint8_t getHandle();</div> <div class="line"><a name="l00075"></a><span class="lineno"> 75</span> </div> <div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="keyword">protected</span>:</div> <div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keywordtype">bool</span> connected;</div> <div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <a class="code" href="group__api__socket__types.html#ga69dc55558df4c81599c5fb3dff98756d">SocketType</a> type;</div> <div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  uint8_t handle;</div> <div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <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="l00081"></a><span class="lineno"> 81</span>  uint16_t localPort;</div> <div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  uint16_t remotePort;</div> <div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <a class="code" href="classwiconnect_1_1_wiconnect.html">Wiconnect</a> *wiconnect;</div> <div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  Buffer txBuffer;</div> <div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  Buffer rxBuffer;</div> <div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </div> <div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <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="l00088"></a><span class="lineno"> 88</span> </div> <div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <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="l00090"></a><span class="lineno"> 90</span> </div> <div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <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="l00092"></a><span class="lineno"> 92</span> };</div> <div class="line"><a name="l00093"></a><span class="lineno"> 93</span> </div> <div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div> <div class="line"><a name="l00095"></a><span class="lineno"> 95</span> }</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#l00293">WiconnectTypes.h:293</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#l00146">WiconnectTypes.h:146</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#l00121">WiconnectTypes.h:121</a></div></div> <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> <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> <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> </div><!-- fragment --></div><!-- contents --> </div><!-- doc-content --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="footer">© ACKme Networks 2014</li> </ul> </div> </body> </html>