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/_file_list_8h_source.html
- Revision:
- 16:7f1d6d359787
- Parent:
- 14:85a2ed029f37
- Child:
- 17:7268f365676b
--- a/doc/html/_file_list_8h_source.html Wed Aug 13 03:15:49 2014 -0700 +++ b/doc/html/_file_list_8h_source.html Wed Aug 13 04:41:04 2014 -0700 @@ -101,54 +101,45 @@ <div class="title">FileList.h</div> </div> </div><!--header--> <div class="contents"> -<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div> -<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright 2014, ACKme Networks</span></div> -<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * All Rights Reserved.</span></div> -<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> *</span></div> -<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <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> <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> <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> <span class="comment"> * written permission of ACKme Networks.</span></div> -<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> */</span></div> -<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> </div> -<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#pragma once</span></div> -<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> </div> -<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> </div> -<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include "Wiconnect.h"</span></div> -<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include "types/File.h"</span></div> -<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div> -<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="keyword">namespace </span>wiconnect</div> -<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> {</div> -<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div> -<div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="classwiconnect_1_1_file_list.html"> 26</a></span> <span class="keyword">class </span><a class="code" href="classwiconnect_1_1_file_list.html">FileList</a></div> -<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> {</div> -<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">public</span>:</div> -<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <a class="code" href="classwiconnect_1_1_file_list.html">FileList</a>(<span class="keywordtype">int</span> bufferLen = 0, <span class="keywordtype">void</span> *buffer = NULL);</div> -<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  ~<a class="code" href="classwiconnect_1_1_file_list.html">FileList</a>();</div> +<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="keyword">const</span> <a class="code" href="classwiconnect_1_1_file.html">File</a>* getListHead() <span class="keyword">const</span>;</div> -<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="keywordtype">int</span> getCount() <span class="keyword">const</span>;</div> -<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="keyword">const</span> <a class="code" href="classwiconnect_1_1_file.html">File</a>* getResult(<span class="keywordtype">int</span> i) <span class="keyword">const</span>;</div> -<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keyword">const</span> <a class="code" href="classwiconnect_1_1_file.html">File</a>* operator [](<span class="keywordtype">int</span> i) <span class="keyword">const</span>;</div> -<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div> -<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">protected</span>:</div> -<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <a class="code" href="classwiconnect_1_1_file.html">File</a> *listHead, *listTail;</div> -<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  uint8_t *buffer;</div> -<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  uint8_t *bufferPtr;</div> -<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keywordtype">int</span> bufferLen;</div> -<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keywordtype">int</span> count;</div> -<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div> -<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> add(<span class="keyword">const</span> <span class="keywordtype">char</span> *typeStr, <span class="keyword">const</span> <span class="keywordtype">char</span> *flagsStr, <span class="keyword">const</span> <span class="keywordtype">char</span>* sizeStr, <span class="keyword">const</span> <span class="keywordtype">char</span> *versionStr, <span class="keyword">const</span> <span class="keywordtype">char</span> *nameStr);</div> -<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div> -<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classwiconnect_1_1_file_interface.html">FileInterface</a>;</div> -<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> };</div> -<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div> +<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include "Wiconnect.h"</span></div> +<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#include "types/File.h"</span></div> +<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div> +<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">namespace </span>wiconnect</div> +<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> {</div> +<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div> +<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="classwiconnect_1_1_file_list.html"> 44</a></span> <span class="keyword">class </span><a class="code" href="classwiconnect_1_1_file_list.html">FileList</a></div> +<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> {</div> +<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="keyword">public</span>:</div> +<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <a class="code" href="classwiconnect_1_1_file_list.html">FileList</a>(<span class="keywordtype">int</span> bufferLen = 0, <span class="keywordtype">void</span> *buffer = NULL);</div> +<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  ~<a class="code" href="classwiconnect_1_1_file_list.html">FileList</a>();</div> <div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div> -<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> }</div> -<div class="ttc" id="classwiconnect_1_1_file_html"><div class="ttname"><a href="classwiconnect_1_1_file.html">wiconnect::File</a></div><div class="ttdoc">WiConnect WiFi module file object. </div><div class="ttdef"><b>Definition:</b> <a href="_file_8h_source.html#l00026">File.h:26</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="classwiconnect_1_1_file_list_html"><div class="ttname"><a href="classwiconnect_1_1_file_list.html">wiconnect::FileList</a></div><div class="ttdoc">WiConnect WiFi module file listing. </div><div class="ttdef"><b>Definition:</b> <a href="_file_list_8h_source.html#l00026">FileList.h:26</a></div></div> -<div class="ttc" id="classwiconnect_1_1_file_interface_html"><div class="ttname"><a href="classwiconnect_1_1_file_interface.html">wiconnect::FileInterface</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="_file_interface_8h_source.html#l00051">FileInterface.h:51</a></div></div> +<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keyword">const</span> <a class="code" href="classwiconnect_1_1_file.html">File</a>* getListHead() <span class="keyword">const</span>;</div> +<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keywordtype">int</span> getCount() <span class="keyword">const</span>;</div> +<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keyword">const</span> <a class="code" href="classwiconnect_1_1_file.html">File</a>* getResult(<span class="keywordtype">int</span> i) <span class="keyword">const</span>;</div> +<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keyword">const</span> <a class="code" href="classwiconnect_1_1_file.html">File</a>* operator [](<span class="keywordtype">int</span> i) <span class="keyword">const</span>;</div> +<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div> +<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="keyword">protected</span>:</div> +<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <a class="code" href="classwiconnect_1_1_file.html">File</a> *listHead, *listTail;</div> +<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  uint8_t *buffer;</div> +<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  uint8_t *bufferPtr;</div> +<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keywordtype">int</span> bufferLen;</div> +<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keywordtype">int</span> count;</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>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> add(<span class="keyword">const</span> <span class="keywordtype">char</span> *typeStr, <span class="keyword">const</span> <span class="keywordtype">char</span> *flagsStr, <span class="keyword">const</span> <span class="keywordtype">char</span>* sizeStr, <span class="keyword">const</span> <span class="keywordtype">char</span> *versionStr, <span class="keyword">const</span> <span class="keywordtype">char</span> *nameStr);</div> +<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div> +<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classwiconnect_1_1_file_interface.html">FileInterface</a>;</div> +<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> };</div> +<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div> +<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div> +<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> }</div> +<div class="ttc" id="classwiconnect_1_1_file_html"><div class="ttname"><a href="classwiconnect_1_1_file.html">wiconnect::File</a></div><div class="ttdoc">WiConnect WiFi module file object. </div><div class="ttdef"><b>Definition:</b> <a href="_file_8h_source.html#l00044">File.h:44</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#l00145">WiconnectTypes.h:145</a></div></div> +<div class="ttc" id="classwiconnect_1_1_file_list_html"><div class="ttname"><a href="classwiconnect_1_1_file_list.html">wiconnect::FileList</a></div><div class="ttdoc">WiConnect WiFi module file listing. </div><div class="ttdef"><b>Definition:</b> <a href="_file_list_8h_source.html#l00044">FileList.h:44</a></div></div> +<div class="ttc" id="classwiconnect_1_1_file_interface_html"><div class="ttname"><a href="classwiconnect_1_1_file_interface.html">wiconnect::FileInterface</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="_file_interface_8h_source.html#l00068">FileInterface.h:68</a></div></div> </div><!-- fragment --></div><!-- contents --> </div><!-- doc-content --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->