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/_command_queue_8h_source.html
- Revision:
- 16:7f1d6d359787
- Parent:
- 14:85a2ed029f37
- Child:
- 17:7268f365676b
diff -r d3cd02b201e1 -r 7f1d6d359787 doc/html/_command_queue_8h_source.html --- a/doc/html/_command_queue_8h_source.html Wed Aug 13 03:15:49 2014 -0700 +++ b/doc/html/_command_queue_8h_source.html Wed Aug 13 04:41:04 2014 -0700 @@ -101,91 +101,82 @@ <div class="title">CommandQueue.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 "WiconnectTypes.h"</span></div> -<div class="line"><a name="l00015"></a><span class="lineno"> 15</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="l00025"></a><span class="lineno"> 25</span> <span class="keyword">class </span>CommandQueue</div> -<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> {</div> -<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="keyword">public</span>:</div> -<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <span class="comment">/*************************************************************************************************/</span></div> -<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  CommandQueue()</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>  head = tail = queue;</div> -<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  count = 0;</div> -<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  }</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="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> </div> -<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="comment">/*************************************************************************************************/</span></div> -<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keywordtype">bool</span> isFull()</div> -<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  {</div> -<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keywordflow">return</span> count == <a class="code" href="group__api__core__macro.html#ga7352d6662e438d0969593df9e657d43f">WICONNECT_MAX_QUEUED_COMMANDS</a>;</div> -<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  }</div> -<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div> -<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="comment">/*************************************************************************************************/</span></div> -<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keywordtype">bool</span> isEmpty()</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>  <span class="keywordflow">return</span> count == 0;</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> </div> -<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="comment">/*************************************************************************************************/</span></div> -<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keywordtype">bool</span> push(QueuedCommand *cmd)</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>  <span class="keywordflow">if</span>(isFull())</div> -<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  {</div> -<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keywordflow">return</span> <span class="keyword">false</span>;</div> -<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  }</div> -<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  ++count;</div> -<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  *tail = cmd;</div> -<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keywordflow">if</span>(++tail >= queue + <a class="code" href="group__api__core__macro.html#ga7352d6662e438d0969593df9e657d43f">WICONNECT_MAX_QUEUED_COMMANDS</a>)</div> -<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  {</div> -<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  tail = queue;</div> -<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  }</div> -<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div> -<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keywordflow">return</span> <span class="keyword">true</span>;</div> -<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  }</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="comment">/*************************************************************************************************/</span></div> -<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  QueuedCommand* pop()</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>  <span class="keywordflow">if</span>(isEmpty())</div> -<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keywordflow">return</span> NULL;</div> -<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div> -<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  QueuedCommand* cmd = *head;</div> -<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  --count;</div> -<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keywordflow">if</span>(++head >= queue + <a class="code" href="group__api__core__macro.html#ga7352d6662e438d0969593df9e657d43f">WICONNECT_MAX_QUEUED_COMMANDS</a>)</div> -<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  {</div> -<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  head = queue;</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="keywordflow">return</span> cmd;</div> -<div class="line"><a name="l00077"></a><span class="lineno"> 77</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="l00043"></a><span class="lineno"> 43</span> <span class="keyword">class </span>CommandQueue</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>  <span class="comment">/*************************************************************************************************/</span></div> +<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  CommandQueue()</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>  head = tail = queue;</div> +<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  count = 0;</div> +<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  }</div> +<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div> +<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="comment">/*************************************************************************************************/</span></div> +<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keywordtype">bool</span> isFull()</div> +<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  {</div> +<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keywordflow">return</span> count == <a class="code" href="group__api__core__macro.html#ga7352d6662e438d0969593df9e657d43f">WICONNECT_MAX_QUEUED_COMMANDS</a>;</div> +<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  }</div> +<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div> +<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="comment">/*************************************************************************************************/</span></div> +<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keywordtype">bool</span> isEmpty()</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>  <span class="keywordflow">return</span> count == 0;</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> </div> +<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="comment">/*************************************************************************************************/</span></div> +<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keywordtype">bool</span> push(QueuedCommand *cmd)</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>  <span class="keywordflow">if</span>(isFull())</div> +<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  {</div> +<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keywordflow">return</span> <span class="keyword">false</span>;</div> +<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  }</div> +<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  ++count;</div> +<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  *tail = cmd;</div> +<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keywordflow">if</span>(++tail >= queue + <a class="code" href="group__api__core__macro.html#ga7352d6662e438d0969593df9e657d43f">WICONNECT_MAX_QUEUED_COMMANDS</a>)</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>  tail = queue;</div> +<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  }</div> <div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div> -<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="keyword">protected</span>:</div> -<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  QueuedCommand* queue[<a class="code" href="group__api__core__macro.html#ga7352d6662e438d0969593df9e657d43f">WICONNECT_MAX_QUEUED_COMMANDS</a>];</div> -<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  QueuedCommand** head;</div> -<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  QueuedCommand** tail;</div> -<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keywordtype">int</span> count;</div> -<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> };</div> -<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> </div> -<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </div> +<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keywordflow">return</span> <span class="keyword">true</span>;</div> +<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  }</div> +<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div> +<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="comment">/*************************************************************************************************/</span></div> +<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  QueuedCommand* pop()</div> +<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  {</div> +<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keywordflow">if</span>(isEmpty())</div> +<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keywordflow">return</span> NULL;</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> </div> -<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> }</div> -<div class="ttc" id="group__api__core__macro_html_ga7352d6662e438d0969593df9e657d43f"><div class="ttname"><a href="group__api__core__macro.html#ga7352d6662e438d0969593df9e657d43f">WICONNECT_MAX_QUEUED_COMMANDS</a></div><div class="ttdeci">#define WICONNECT_MAX_QUEUED_COMMANDS</div><div class="ttdoc">When WICONNECT_ASYNC_TIMER_ENABLED, this specifies the max number of asynchronous commands that may b...</div><div class="ttdef"><b>Definition:</b> <a href="sdk_8h_source.html#l00067">sdk.h:67</a></div></div> +<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  QueuedCommand* cmd = *head;</div> +<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  --count;</div> +<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="keywordflow">if</span>(++head >= queue + <a class="code" href="group__api__core__macro.html#ga7352d6662e438d0969593df9e657d43f">WICONNECT_MAX_QUEUED_COMMANDS</a>)</div> +<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  {</div> +<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  head = queue;</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>  <span class="keywordflow">return</span> cmd;</div> +<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  }</div> +<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> </div> +<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="keyword">protected</span>:</div> +<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  QueuedCommand* queue[<a class="code" href="group__api__core__macro.html#ga7352d6662e438d0969593df9e657d43f">WICONNECT_MAX_QUEUED_COMMANDS</a>];</div> +<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  QueuedCommand** head;</div> +<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  QueuedCommand** tail;</div> +<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="keywordtype">int</span> count;</div> +<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> };</div> +<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> </div> +<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> </div> +<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> </div> +<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> </div> +<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> }</div> +<div class="ttc" id="group__api__core__macro_html_ga7352d6662e438d0969593df9e657d43f"><div class="ttname"><a href="group__api__core__macro.html#ga7352d6662e438d0969593df9e657d43f">WICONNECT_MAX_QUEUED_COMMANDS</a></div><div class="ttdeci">#define WICONNECT_MAX_QUEUED_COMMANDS</div><div class="ttdoc">When WICONNECT_ASYNC_TIMER_ENABLED, this specifies the max number of asynchronous commands that may b...</div><div class="ttdef"><b>Definition:</b> <a href="sdk_8h_source.html#l00085">sdk.h:85</a></div></div> </div><!-- fragment --></div><!-- contents --> </div><!-- doc-content --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->