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/_wiconnect_socket_8h_source.html
- Revision:
- 29:b6af04b77a56
- Parent:
- 26:8067e3d463d3
--- a/doc/html/_wiconnect_socket_8h_source.html Mon Oct 27 13:32:40 2014 -0700 +++ b/doc/html/_wiconnect_socket_8h_source.html Mon Oct 27 13:42:26 2014 -0700 @@ -105,7 +105,7 @@ <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="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include "api/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> @@ -126,7 +126,7 @@ <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">true</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="l00059"></a><span class="lineno"> 59</span>  <span class="keyword">virtual</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> @@ -145,30 +145,31 @@ <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="l00078"></a><span class="lineno"> 78</span>  <span class="keywordtype">bool</span> enableAutoClose;</div> +<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <a class="code" href="group__api__socket__types.html#ga69dc55558df4c81599c5fb3dff98756d">SocketType</a> type;</div> +<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  uint8_t handle;</div> +<div class="line"><a name="l00081"></a><span class="lineno"> 81</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="l00082"></a><span class="lineno"> 82</span>  uint16_t localPort;</div> +<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  uint16_t remotePort;</div> +<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <a class="code" href="classwiconnect_1_1_wiconnect.html">Wiconnect</a> *wiconnect;</div> +<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  Buffer txBuffer;</div> +<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  Buffer rxBuffer;</div> +<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> </div> +<div class="line"><a name="l00088"></a><span class="lineno"> 88</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="l00089"></a><span class="lineno"> 89</span> </div> +<div class="line"><a name="l00090"></a><span class="lineno"> 90</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="l00091"></a><span class="lineno"> 91</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classwiconnect_1_1_ghm_interface.html">GhmInterface</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#l00324">WiconnectTypes.h:324</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#l00159">WiconnectTypes.h:159</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="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#l00338">WiconnectTypes.h:338</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#l00166">WiconnectTypes.h:166</a></div></div> +<div class="ttc" id="classwiconnect_1_1_ghm_interface_html"><div class="ttname"><a href="classwiconnect_1_1_ghm_interface.html">wiconnect::GhmInterface</a></div><div class="ttdoc">The provides an interface for http://goHACK.me. </div><div class="ttdef"><b>Definition:</b> <a href="_ghm_interface_8h_source.html#l00081">GhmInterface.h:81</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#l00128">WiconnectTypes.h:128</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 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#l00063">SocketInterface.h:63</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#l00078">WiconnectInterface.h:78</a></div></div> </div><!-- fragment --></div><!-- contents --> </div><!-- doc-content --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->