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/_socket_irq_handler_map_8h_source.html
- Committer:
- dan_ackme
- Date:
- 2014-10-23
- Revision:
- 26:8067e3d463d3
- Parent:
- 21:17bb3eddcbae
- Child:
- 29:b6af04b77a56
File content as of revision 26:8067e3d463d3:
<!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/2.0/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('_socket_irq_handler_map_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">SocketIrqHandlerMap.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> <span class="preprocessor">#include "Wiconnect.h"</span></div> <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include "types/PinIrqHandler.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="l00042"></a><span class="lineno"> 42</span> <span class="keyword">class </span>SocketIrqHandlerMap</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="keyword">public</span>:</div> <div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="comment">/*************************************************************************************************/</span></div> <div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  SocketIrqHandlerMap()</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>  memset(handlers, 0, <span class="keyword">sizeof</span>(handlers));</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="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="comment">/*************************************************************************************************/</span></div> <div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  ~SocketIrqHandlerMap()</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>  <span class="keywordflow">for</span>(<span class="keywordtype">int</span> i = 0; i < WICONNECT_MAX_PIN_IRQ_HANDLERS; ++i)</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">if</span>(handlers[i] != NULL)</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>  handlers[i]->~PinIrqHandler();</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>  }</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>  <span class="comment">/*************************************************************************************************/</span></div> <div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keywordtype">bool</span> pinIsRegistered(<a class="code" href="group__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> pin)</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>  <span class="keywordflow">for</span>(<span class="keywordtype">int</span> i = 0; i < WICONNECT_MAX_PIN_IRQ_HANDLERS; ++i)</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>(handlers[i] != NULL && handlers[i]->irqPin == pin)</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">true</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>  }</div> <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keywordflow">return</span> <span class="keyword">false</span>;</div> <div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  }</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="comment">/*************************************************************************************************/</span></div> <div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> registerHandler(<a class="code" href="group__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> pin, <span class="keyword">const</span> <a class="code" href="classwiconnect_1_1_callback.html">Callback</a> &callback)</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="keywordflow">if</span>(pinIsRegistered(pin))</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>  <span class="keywordflow">return</span> <a class="code" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05a5d9162280a5269a34245bf53c87401a4">WICONNECT_DUPLICATE</a>;</div> <div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  }</div> <div class="line"><a name="l00083"></a><span class="lineno"> 83</span> </div> <div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  PinIrqHandler *handler = NULL;</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>  <span class="keywordflow">for</span>(<span class="keywordtype">int</span> i = 0; i < WICONNECT_MAX_PIN_IRQ_HANDLERS; ++i)</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>  <span class="keywordflow">if</span>(handlers[i] == NULL)</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>  handler = (PinIrqHandler*)&handlerBuffers[i];</div> <div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  handlers[i] = handler;</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>  <span class="keywordflow">if</span>(handler == NULL)</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="keywordflow">return</span> <a class="code" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05ab9123e9628c3156f34c44913a72b4195">WICONNECT_NOT_FOUND</a>;</div> <div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  }</div> <div class="line"><a name="l00099"></a><span class="lineno"> 99</span> </div> <div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  *handler = PinIrqHandler(pin, callback);</div> <div class="line"><a name="l00101"></a><span class="lineno"> 101</span> </div> <div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="keywordflow">return</span> <a class="code" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05af0a2ad8af174aee6b52813d8528328e7">WICONNECT_SUCCESS</a>;</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>  <span class="comment">/*************************************************************************************************/</span></div> <div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> unregisterHandler(<a class="code" href="group__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> pin)</div> <div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  {</div> <div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  <span class="keywordflow">for</span>(<span class="keywordtype">int</span> i = 0; i < WICONNECT_MAX_PIN_IRQ_HANDLERS; ++i)</div> <div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  {</div> <div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="keywordflow">if</span>(handlers[i] != NULL && handlers[i]->irqPin == pin)</div> <div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  {</div> <div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  handlers[i]->~PinIrqHandler();</div> <div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  handlers[i] = NULL;</div> <div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  <span class="keywordflow">return</span> <a class="code" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05af0a2ad8af174aee6b52813d8528328e7">WICONNECT_SUCCESS</a>;</div> <div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  }</div> <div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  }</div> <div class="line"><a name="l00117"></a><span class="lineno"> 117</span> </div> <div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  <span class="keywordflow">return</span> <a class="code" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05ab9123e9628c3156f34c44913a72b4195">WICONNECT_NOT_FOUND</a>;</div> <div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  }</div> <div class="line"><a name="l00120"></a><span class="lineno"> 120</span> </div> <div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="keyword">private</span>:</div> <div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  PinIrqHandler *handlers[WICONNECT_MAX_PIN_IRQ_HANDLERS];</div> <div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  PinIrqHandlerBuffer handlerBuffers[WICONNECT_MAX_PIN_IRQ_HANDLERS];</div> <div class="line"><a name="l00124"></a><span class="lineno"> 124</span> };</div> <div class="line"><a name="l00125"></a><span class="lineno"> 125</span> </div> <div class="line"><a name="l00126"></a><span class="lineno"> 126</span> </div> <div class="line"><a name="l00127"></a><span class="lineno"> 127</span> </div> <div class="line"><a name="l00128"></a><span class="lineno"> 128</span> }</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="classwiconnect_1_1_callback_html"><div class="ttname"><a href="classwiconnect_1_1_callback.html">wiconnect::Callback</a></div><div class="ttdoc">Generic callback function. </div><div class="ttdef"><b>Definition:</b> <a href="_callback_8h_source.html#l00049">Callback.h:49</a></div></div> <div class="ttc" id="group__api__core__types_html_gga325637ed501728bd6c8c7a7982b9ce05ab9123e9628c3156f34c44913a72b4195"><div class="ttname"><a href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05ab9123e9628c3156f34c44913a72b4195">wiconnect::WICONNECT_NOT_FOUND</a></div><div class="ttdoc">Not found. </div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_types_8h_source.html#l00181">WiconnectTypes.h:181</a></div></div> <div class="ttc" id="group__api__core__types_html_ga1cf4dfa71da0b0dc3dc707dacf56cc9c"><div class="ttname"><a href="group__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">wiconnect::Pin</a></div><div class="ttdeci">PinName Pin</div><div class="ttdoc">Pin name on HOST. </div><div class="ttdef"><b>Definition:</b> <a href="sdk_8h_source.html#l00123">sdk.h:123</a></div></div> <div class="ttc" id="group__api__core__types_html_gga325637ed501728bd6c8c7a7982b9ce05a5d9162280a5269a34245bf53c87401a4"><div class="ttname"><a href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05a5d9162280a5269a34245bf53c87401a4">wiconnect::WICONNECT_DUPLICATE</a></div><div class="ttdoc">Duplicate value. </div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_types_8h_source.html#l00180">WiconnectTypes.h:180</a></div></div> <div class="ttc" id="group__api__core__types_html_gga325637ed501728bd6c8c7a7982b9ce05af0a2ad8af174aee6b52813d8528328e7"><div class="ttname"><a href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05af0a2ad8af174aee6b52813d8528328e7">wiconnect::WICONNECT_SUCCESS</a></div><div class="ttdoc">Command successfully completed. </div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_types_8h_source.html#l00165">WiconnectTypes.h:165</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>