ACKme / WiConnect

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/_file_interface_8h_source.html@14:85a2ed029f37, 2014-08-13 (annotated)

Committer:
dan_ackme
Date:
Wed Aug 13 03:14:43 2014 -0700
Revision:
14:85a2ed029f37
Child:
16:7f1d6d359787
doc updates

Who changed what in which revision?

UserRevisionLine numberNew contents of line
dan_ackme 14:85a2ed029f37 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
dan_ackme 14:85a2ed029f37 2 <html xmlns="http://www.w3.org/1999/xhtml">
dan_ackme 14:85a2ed029f37 3 <head>
dan_ackme 14:85a2ed029f37 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
dan_ackme 14:85a2ed029f37 5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
dan_ackme 14:85a2ed029f37 6 <title>ACKme WiConnect Host Library</title>
dan_ackme 14:85a2ed029f37 7 <link rel="icon" href="favicon.ico" type="image/x-icon">
dan_ackme 14:85a2ed029f37 8 <link rel="shortcut icon" href="favicon.ico" type="image/x-icon">
dan_ackme 14:85a2ed029f37 9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
dan_ackme 14:85a2ed029f37 10 <script type="text/javascript" src="jquery.js"></script>
dan_ackme 14:85a2ed029f37 11 <script type="text/javascript" src="dynsections.js"></script>
dan_ackme 14:85a2ed029f37 12 <link href="navtree.css" rel="stylesheet" type="text/css"/>
dan_ackme 14:85a2ed029f37 13 <script type="text/javascript" src="resize.js"></script>
dan_ackme 14:85a2ed029f37 14 <script type="text/javascript" src="navtree.js"></script>
dan_ackme 14:85a2ed029f37 15 <script type="text/javascript">
dan_ackme 14:85a2ed029f37 16 $(document).ready(initResizable);
dan_ackme 14:85a2ed029f37 17 $(window).load(resizeHeight);
dan_ackme 14:85a2ed029f37 18 </script>
dan_ackme 14:85a2ed029f37 19 <link href="search/search.css" rel="stylesheet" type="text/css"/>
dan_ackme 14:85a2ed029f37 20 <script type="text/javascript" src="search/search.js"></script>
dan_ackme 14:85a2ed029f37 21 <script type="text/javascript">
dan_ackme 14:85a2ed029f37 22 $(document).ready(function() { searchBox.OnSelectItem(0); });
dan_ackme 14:85a2ed029f37 23 </script>
dan_ackme 14:85a2ed029f37 24 <link href="doxygen.css" rel="stylesheet" type="text/css" />
dan_ackme 14:85a2ed029f37 25 </head>
dan_ackme 14:85a2ed029f37 26 <body>
dan_ackme 14:85a2ed029f37 27 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
dan_ackme 14:85a2ed029f37 28 <div id="titlearea" style="font-family:verdana;">
dan_ackme 14:85a2ed029f37 29 <table border='0' cellpadding='0' cellspacing='0' width="98%">
dan_ackme 14:85a2ed029f37 30 <tr style="height:20px"><td>&nbsp;</td></tr>
dan_ackme 14:85a2ed029f37 31 <tr style="border-collapse: collapse; padding: 0;">
dan_ackme 14:85a2ed029f37 32 <td style="width:20px"></td>
dan_ackme 14:85a2ed029f37 33 <td style="padding-right:40px"><img src="ackmelogo.png" alt="ACKme Logo" /></td>
dan_ackme 14:85a2ed029f37 34 <td style="vertical-align:middle; text-align:left; font: bold 25px/100% Verdana, Arial, Helvetica, sans-serif;">
dan_ackme 14:85a2ed029f37 35 WiConnect Host Library- API Reference Guide</td>
dan_ackme 14:85a2ed029f37 36 <td style="width:20px"></td>
dan_ackme 14:85a2ed029f37 37 </tr>
dan_ackme 14:85a2ed029f37 38 <tr><td>&nbsp;</td></tr>
dan_ackme 14:85a2ed029f37 39 </table>
dan_ackme 14:85a2ed029f37 40 </div><!-- Generated by Doxygen 1.8.7 -->
dan_ackme 14:85a2ed029f37 41 <script type="text/javascript">
dan_ackme 14:85a2ed029f37 42 var searchBox = new SearchBox("searchBox", "search",false,'Search');
dan_ackme 14:85a2ed029f37 43 </script>
dan_ackme 14:85a2ed029f37 44 <div id="navrow1" class="tabs">
dan_ackme 14:85a2ed029f37 45 <ul class="tablist">
dan_ackme 14:85a2ed029f37 46 <li><a href="index.html"><span>Library&#160;Overview</span></a></li>
dan_ackme 14:85a2ed029f37 47 <li><a href="modules.html"><span>Library&#160;API</span></a></li>
dan_ackme 14:85a2ed029f37 48 <li><a href="examples.html"><span>API&#160;Examples</span></a></li>
dan_ackme 14:85a2ed029f37 49 <li><a href="annotated.html"><span>Classes</span></a></li>
dan_ackme 14:85a2ed029f37 50 <li><a href="http://wiconnect.ack.me/1.2/general_overview"><span>WiConnect&#160;Reference&#160;Manual</span></a></li>
dan_ackme 14:85a2ed029f37 51 <li><a href="http://www.ack.me/WiConnect"><span>ACKme&#160;Website</span></a></li>
dan_ackme 14:85a2ed029f37 52 <li>
dan_ackme 14:85a2ed029f37 53 <div id="MSearchBox" class="MSearchBoxInactive">
dan_ackme 14:85a2ed029f37 54 <span class="left">
dan_ackme 14:85a2ed029f37 55 <img id="MSearchSelect" src="search/mag_sel.png"
dan_ackme 14:85a2ed029f37 56 onmouseover="return searchBox.OnSearchSelectShow()"
dan_ackme 14:85a2ed029f37 57 onmouseout="return searchBox.OnSearchSelectHide()"
dan_ackme 14:85a2ed029f37 58 alt=""/>
dan_ackme 14:85a2ed029f37 59 <input type="text" id="MSearchField" value="Search" accesskey="S"
dan_ackme 14:85a2ed029f37 60 onfocus="searchBox.OnSearchFieldFocus(true)"
dan_ackme 14:85a2ed029f37 61 onblur="searchBox.OnSearchFieldFocus(false)"
dan_ackme 14:85a2ed029f37 62 onkeyup="searchBox.OnSearchFieldChange(event)"/>
dan_ackme 14:85a2ed029f37 63 </span><span class="right">
dan_ackme 14:85a2ed029f37 64 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
dan_ackme 14:85a2ed029f37 65 </span>
dan_ackme 14:85a2ed029f37 66 </div>
dan_ackme 14:85a2ed029f37 67 </li>
dan_ackme 14:85a2ed029f37 68 </ul>
dan_ackme 14:85a2ed029f37 69 </div>
dan_ackme 14:85a2ed029f37 70 </div><!-- top -->
dan_ackme 14:85a2ed029f37 71 <div id="side-nav" class="ui-resizable side-nav-resizable">
dan_ackme 14:85a2ed029f37 72 <div id="nav-tree">
dan_ackme 14:85a2ed029f37 73 <div id="nav-tree-contents">
dan_ackme 14:85a2ed029f37 74 <div id="nav-sync" class="sync"></div>
dan_ackme 14:85a2ed029f37 75 </div>
dan_ackme 14:85a2ed029f37 76 </div>
dan_ackme 14:85a2ed029f37 77 <div id="splitbar" style="-moz-user-select:none;"
dan_ackme 14:85a2ed029f37 78 class="ui-resizable-handle">
dan_ackme 14:85a2ed029f37 79 </div>
dan_ackme 14:85a2ed029f37 80 </div>
dan_ackme 14:85a2ed029f37 81 <script type="text/javascript">
dan_ackme 14:85a2ed029f37 82 $(document).ready(function(){initNavTree('_file_interface_8h_source.html','');});
dan_ackme 14:85a2ed029f37 83 </script>
dan_ackme 14:85a2ed029f37 84 <div id="doc-content">
dan_ackme 14:85a2ed029f37 85 <!-- window showing the filter options -->
dan_ackme 14:85a2ed029f37 86 <div id="MSearchSelectWindow"
dan_ackme 14:85a2ed029f37 87 onmouseover="return searchBox.OnSearchSelectShow()"
dan_ackme 14:85a2ed029f37 88 onmouseout="return searchBox.OnSearchSelectHide()"
dan_ackme 14:85a2ed029f37 89 onkeydown="return searchBox.OnSearchSelectKey(event)">
dan_ackme 14:85a2ed029f37 90 <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Pages</a></div>
dan_ackme 14:85a2ed029f37 91
dan_ackme 14:85a2ed029f37 92 <!-- iframe showing the search results (closed by default) -->
dan_ackme 14:85a2ed029f37 93 <div id="MSearchResultsWindow">
dan_ackme 14:85a2ed029f37 94 <iframe src="javascript:void(0)" frameborder="0"
dan_ackme 14:85a2ed029f37 95 name="MSearchResults" id="MSearchResults">
dan_ackme 14:85a2ed029f37 96 </iframe>
dan_ackme 14:85a2ed029f37 97 </div>
dan_ackme 14:85a2ed029f37 98
dan_ackme 14:85a2ed029f37 99 <div class="header">
dan_ackme 14:85a2ed029f37 100 <div class="headertitle">
dan_ackme 14:85a2ed029f37 101 <div class="title">FileInterface.h</div> </div>
dan_ackme 14:85a2ed029f37 102 </div><!--header-->
dan_ackme 14:85a2ed029f37 103 <div class="contents">
dan_ackme 14:85a2ed029f37 104 <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div>
dan_ackme 14:85a2ed029f37 105 <div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * Copyright 2014, ACKme Networks</span></div>
dan_ackme 14:85a2ed029f37 106 <div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> * All Rights Reserved.</span></div>
dan_ackme 14:85a2ed029f37 107 <div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> *</span></div>
dan_ackme 14:85a2ed029f37 108 <div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * This is UNPUBLISHED PROPRIETARY SOURCE CODE of ACKme Networks;</span></div>
dan_ackme 14:85a2ed029f37 109 <div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * the contents of this file may not be disclosed to third parties, copied</span></div>
dan_ackme 14:85a2ed029f37 110 <div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * or duplicated in any form, in whole or in part, without the prior</span></div>
dan_ackme 14:85a2ed029f37 111 <div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> * written permission of ACKme Networks.</span></div>
dan_ackme 14:85a2ed029f37 112 <div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> */</span></div>
dan_ackme 14:85a2ed029f37 113 <div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;</div>
dan_ackme 14:85a2ed029f37 114 <div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor">#pragma once</span></div>
dan_ackme 14:85a2ed029f37 115 <div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;</div>
dan_ackme 14:85a2ed029f37 116 <div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#include &quot;mbed.h&quot;</span></div>
dan_ackme 14:85a2ed029f37 117 <div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;</div>
dan_ackme 14:85a2ed029f37 118 <div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#include &quot;WiconnectTypes.h&quot;</span></div>
dan_ackme 14:85a2ed029f37 119 <div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#include &quot;types/FileList.h&quot;</span></div>
dan_ackme 14:85a2ed029f37 120 <div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;</div>
dan_ackme 14:85a2ed029f37 121 <div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;</div>
dan_ackme 14:85a2ed029f37 122 <div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="group__api__file__macro.html#gaa124c352091337449140487b9f9db040"> 23</a></span>&#160;<span class="preprocessor">#define FILE_NAME_MAX_SIZE 96</span></div>
dan_ackme 14:85a2ed029f37 123 <div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;</div>
dan_ackme 14:85a2ed029f37 124 <div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="group__api__file__macro.html#gac39210b86d0465e494a6d0d56cf8dd05"> 30</a></span>&#160;<span class="preprocessor">#define FILE_MAKE_VERSION(major, minor, patch, rc) ((unsigned int)((major) &lt;&lt; 27)|(unsigned int)((minor) &lt;&lt; 21)|(unsigned int)((patch) &lt;&lt; 8)|(unsigned int)((rc) &lt;&lt; 0))</span></div>
dan_ackme 14:85a2ed029f37 125 <div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;</div>
dan_ackme 14:85a2ed029f37 126 <div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="group__api__file__macro.html#ga132e94ace044130d574117ac13c7fd24"> 36</a></span>&#160;<span class="preprocessor">#define FILE_VERSION_ARGS(version) (unsigned int)((version &gt;&gt; 27) &amp; 0x1F),(unsigned int)((version &gt;&gt; 21) &amp; 0x3F),(unsigned int)((version &gt;&gt; 8) &amp; 0x1FFF),(unsigned int)(version &amp; 0xFF)</span></div>
dan_ackme 14:85a2ed029f37 127 <div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;</div>
dan_ackme 14:85a2ed029f37 128 <div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;</div>
dan_ackme 14:85a2ed029f37 129 <div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="namespacewiconnect.html"> 39</a></span>&#160;<span class="keyword">namespace </span>wiconnect {</div>
dan_ackme 14:85a2ed029f37 130 <div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;</div>
dan_ackme 14:85a2ed029f37 131 <div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;</div>
dan_ackme 14:85a2ed029f37 132 <div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="classwiconnect_1_1_file_interface.html"> 51</a></span>&#160;<span class="keyword">class </span><a class="code" href="classwiconnect_1_1_file_interface.html">FileInterface</a></div>
dan_ackme 14:85a2ed029f37 133 <div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;{</div>
dan_ackme 14:85a2ed029f37 134 <div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;<span class="keyword">public</span>:</div>
dan_ackme 14:85a2ed029f37 135 <div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__file__methods.html#ga16fb09105975644879eb09581ce486e5">createFile</a>(<span class="keyword">const</span> <a class="code" href="classwiconnect_1_1_reader_func.html">ReaderFunc</a> &amp;reader, <span class="keywordtype">void</span> *user, <span class="keyword">const</span> <span class="keywordtype">char</span> *name, uint32_t size, uint32_t version = 0, <a class="code" href="group__api__file__types.html#ga9919a4237eea2b0d1f27c16d64e62c63">FileType</a> type = FILE_TYPE_ANY, <span class="keywordtype">bool</span> isEssential = <span class="keyword">false</span>, int32_t checksum = -1);</div>
dan_ackme 14:85a2ed029f37 136 <div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160;</div>
dan_ackme 14:85a2ed029f37 137 <div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__file__methods.html#ga4b14d6c68d4d0239e150def385c334a4">openFile</a>(<a class="code" href="classwiconnect_1_1_file.html">File</a> &amp;file, <span class="keyword">const</span> <span class="keywordtype">char</span> *name);</div>
dan_ackme 14:85a2ed029f37 138 <div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160;</div>
dan_ackme 14:85a2ed029f37 139 <div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__file__methods.html#gafcf335cef42b7b3d0fd9d5af70c6ef7d">deleteFile</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *name);</div>
dan_ackme 14:85a2ed029f37 140 <div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160;</div>
dan_ackme 14:85a2ed029f37 141 <div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__file__methods.html#gafcf335cef42b7b3d0fd9d5af70c6ef7d">deleteFile</a>(<span class="keyword">const</span> <a class="code" href="classwiconnect_1_1_file.html">File</a> &amp;file);</div>
dan_ackme 14:85a2ed029f37 142 <div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160;</div>
dan_ackme 14:85a2ed029f37 143 <div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160; <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__file__methods.html#ga10536639c61213c037883dade021838f">listFiles</a>(<a class="code" href="classwiconnect_1_1_file_list.html">FileList</a> &amp;list, <span class="keyword">const</span> <span class="keywordtype">char</span> *name = NULL, <a class="code" href="group__api__file__types.html#ga9919a4237eea2b0d1f27c16d64e62c63">FileType</a> type = FILE_TYPE_ANY, uint32_t version = 0);</div>
dan_ackme 14:85a2ed029f37 144 <div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160;</div>
dan_ackme 14:85a2ed029f37 145 <div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160;</div>
dan_ackme 14:85a2ed029f37 146 <div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160; <span class="comment">// ------------------------------------------------------------------------</span></div>
dan_ackme 14:85a2ed029f37 147 <div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160;</div>
dan_ackme 14:85a2ed029f37 148 <div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160;</div>
dan_ackme 14:85a2ed029f37 149 <div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="group__conversion__util.html#gad74fbe6faf90d987b31380978f3ea341">fileVersionIntToStr</a>(uint32_t version, <span class="keywordtype">bool</span> verbose = <span class="keyword">true</span>, <span class="keywordtype">char</span> *buffer = NULL);</div>
dan_ackme 14:85a2ed029f37 150 <div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160;</div>
dan_ackme 14:85a2ed029f37 151 <div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="group__conversion__util.html#gae995028f5a70c58ccf6013c9811e79aa">fileVersionStrToInt</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *versionStr, uint32_t *versionIntPtr);</div>
dan_ackme 14:85a2ed029f37 152 <div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160;</div>
dan_ackme 14:85a2ed029f37 153 <div class="line"><a name="l00153"></a><span class="lineno"> 153</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="group__conversion__util.html#ga8d8da39cd5d2948367429ed4d8885c6b">fileTypeToStr</a>(<a class="code" href="group__api__file__types.html#ga9919a4237eea2b0d1f27c16d64e62c63">FileType</a> type);</div>
dan_ackme 14:85a2ed029f37 154 <div class="line"><a name="l00154"></a><span class="lineno"> 154</span>&#160;</div>
dan_ackme 14:85a2ed029f37 155 <div class="line"><a name="l00160"></a><span class="lineno"> 160</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="group__conversion__util.html#ga7503f1876a6e1f5086d8b4bb2c1a653a">fileFlagsToStr</a>(<a class="code" href="group__api__file__types.html#gafbe48908f5c190c3b0f272d3016e609e">FileFlags</a> flags, <span class="keywordtype">char</span> *buffer = NULL);</div>
dan_ackme 14:85a2ed029f37 156 <div class="line"><a name="l00161"></a><span class="lineno"> 161</span>&#160;</div>
dan_ackme 14:85a2ed029f37 157 <div class="line"><a name="l00162"></a><span class="lineno"> 162</span>&#160;<span class="keyword">protected</span>:</div>
dan_ackme 14:85a2ed029f37 158 <div class="line"><a name="l00163"></a><span class="lineno"> 163</span>&#160; <a class="code" href="classwiconnect_1_1_file_interface.html">FileInterface</a>(<a class="code" href="classwiconnect_1_1_wiconnect.html">Wiconnect</a> *wiconnect);</div>
dan_ackme 14:85a2ed029f37 159 <div class="line"><a name="l00164"></a><span class="lineno"> 164</span>&#160;</div>
dan_ackme 14:85a2ed029f37 160 <div class="line"><a name="l00165"></a><span class="lineno"> 165</span>&#160; <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> processFileList(<span class="keywordtype">char</span> *responseStr, <a class="code" href="classwiconnect_1_1_file_list.html">FileList</a> &amp;list, <span class="keyword">const</span> <span class="keywordtype">char</span> *name, <a class="code" href="group__api__file__types.html#ga9919a4237eea2b0d1f27c16d64e62c63">FileType</a> type, uint32_t version);</div>
dan_ackme 14:85a2ed029f37 161 <div class="line"><a name="l00166"></a><span class="lineno"> 166</span>&#160;<span class="keyword">private</span>:</div>
dan_ackme 14:85a2ed029f37 162 <div class="line"><a name="l00167"></a><span class="lineno"> 167</span>&#160; <a class="code" href="classwiconnect_1_1_wiconnect.html">Wiconnect</a> *wiconnect;</div>
dan_ackme 14:85a2ed029f37 163 <div class="line"><a name="l00168"></a><span class="lineno"> 168</span>&#160;};</div>
dan_ackme 14:85a2ed029f37 164 <div class="line"><a name="l00169"></a><span class="lineno"> 169</span>&#160;</div>
dan_ackme 14:85a2ed029f37 165 <div class="line"><a name="l00170"></a><span class="lineno"> 170</span>&#160;}</div>
dan_ackme 14:85a2ed029f37 166 <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>
dan_ackme 14:85a2ed029f37 167 <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>
dan_ackme 14:85a2ed029f37 168 <div class="ttc" id="group__conversion__util_html_gae995028f5a70c58ccf6013c9811e79aa"><div class="ttname"><a href="group__conversion__util.html#gae995028f5a70c58ccf6013c9811e79aa">wiconnect::FileInterface::fileVersionStrToInt</a></div><div class="ttdeci">static bool fileVersionStrToInt(const char *versionStr, uint32_t *versionIntPtr)</div><div class="ttdoc">Convert string to file version uint32. </div></div>
dan_ackme 14:85a2ed029f37 169 <div class="ttc" id="group__conversion__util_html_ga8d8da39cd5d2948367429ed4d8885c6b"><div class="ttname"><a href="group__conversion__util.html#ga8d8da39cd5d2948367429ed4d8885c6b">wiconnect::FileInterface::fileTypeToStr</a></div><div class="ttdeci">static const char * fileTypeToStr(FileType type)</div></div>
dan_ackme 14:85a2ed029f37 170 <div class="ttc" id="group__api__file__methods_html_ga10536639c61213c037883dade021838f"><div class="ttname"><a href="group__api__file__methods.html#ga10536639c61213c037883dade021838f">wiconnect::FileInterface::listFiles</a></div><div class="ttdeci">WiconnectResult listFiles(FileList &amp;list, const char *name=NULL, FileType type=FILE_TYPE_ANY, uint32_t version=0)</div><div class="ttdoc">List the files on the Wiconnect WiFi module filesystem. </div></div>
dan_ackme 14:85a2ed029f37 171 <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>
dan_ackme 14:85a2ed029f37 172 <div class="ttc" id="classwiconnect_1_1_reader_func_html"><div class="ttname"><a href="classwiconnect_1_1_reader_func.html">wiconnect::ReaderFunc</a></div><div class="ttdoc">Generic data reading callback function. </div><div class="ttdef"><b>Definition:</b> <a href="_reader_func_8h_source.html#l00027">ReaderFunc.h:27</a></div></div>
dan_ackme 14:85a2ed029f37 173 <div class="ttc" id="group__api__file__methods_html_ga4b14d6c68d4d0239e150def385c334a4"><div class="ttname"><a href="group__api__file__methods.html#ga4b14d6c68d4d0239e150def385c334a4">wiconnect::FileInterface::openFile</a></div><div class="ttdeci">WiconnectResult openFile(File &amp;file, const char *name)</div><div class="ttdoc">Open a file on the Wiconnect WiFi module filesystem for reading. </div></div>
dan_ackme 14:85a2ed029f37 174 <div class="ttc" id="group__api__file__methods_html_gafcf335cef42b7b3d0fd9d5af70c6ef7d"><div class="ttname"><a href="group__api__file__methods.html#gafcf335cef42b7b3d0fd9d5af70c6ef7d">wiconnect::FileInterface::deleteFile</a></div><div class="ttdeci">WiconnectResult deleteFile(const char *name)</div><div class="ttdoc">Delete a file for the Wiconnect WiFi module filesystem. </div></div>
dan_ackme 14:85a2ed029f37 175 <div class="ttc" id="group__api__file__types_html_ga9919a4237eea2b0d1f27c16d64e62c63"><div class="ttname"><a href="group__api__file__types.html#ga9919a4237eea2b0d1f27c16d64e62c63">wiconnect::FileType</a></div><div class="ttdeci">FileType</div><div class="ttdoc">File type type. </div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_types_8h_source.html#l00333">WiconnectTypes.h:333</a></div></div>
dan_ackme 14:85a2ed029f37 176 <div class="ttc" id="group__api__file__methods_html_ga16fb09105975644879eb09581ce486e5"><div class="ttname"><a href="group__api__file__methods.html#ga16fb09105975644879eb09581ce486e5">wiconnect::FileInterface::createFile</a></div><div class="ttdeci">WiconnectResult createFile(const ReaderFunc &amp;reader, void *user, const char *name, uint32_t size, uint32_t version=0, FileType type=FILE_TYPE_ANY, bool isEssential=false, int32_t checksum=-1)</div><div class="ttdoc">Create a file on the Wiconnect WiFi module filesystem. </div></div>
dan_ackme 14:85a2ed029f37 177 <div class="ttc" id="group__conversion__util_html_gad74fbe6faf90d987b31380978f3ea341"><div class="ttname"><a href="group__conversion__util.html#gad74fbe6faf90d987b31380978f3ea341">wiconnect::FileInterface::fileVersionIntToStr</a></div><div class="ttdeci">static const char * fileVersionIntToStr(uint32_t version, bool verbose=true, char *buffer=NULL)</div><div class="ttdoc">Convert file version uint32 to string. </div></div>
dan_ackme 14:85a2ed029f37 178 <div class="ttc" id="group__api__file__types_html_gafbe48908f5c190c3b0f272d3016e609e"><div class="ttname"><a href="group__api__file__types.html#gafbe48908f5c190c3b0f272d3016e609e">wiconnect::FileFlags</a></div><div class="ttdeci">FileFlags</div><div class="ttdoc">File flags type. </div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_types_8h_source.html#l00314">WiconnectTypes.h:314</a></div></div>
dan_ackme 14:85a2ed029f37 179 <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#l00056">WiconnectInterface.h:56</a></div></div>
dan_ackme 14:85a2ed029f37 180 <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>
dan_ackme 14:85a2ed029f37 181 <div class="ttc" id="group__conversion__util_html_ga7503f1876a6e1f5086d8b4bb2c1a653a"><div class="ttname"><a href="group__conversion__util.html#ga7503f1876a6e1f5086d8b4bb2c1a653a">wiconnect::FileInterface::fileFlagsToStr</a></div><div class="ttdeci">static const char * fileFlagsToStr(FileFlags flags, char *buffer=NULL)</div><div class="ttdoc">Convert FileFlags to string. </div></div>
dan_ackme 14:85a2ed029f37 182 </div><!-- fragment --></div><!-- contents -->
dan_ackme 14:85a2ed029f37 183 </div><!-- doc-content -->
dan_ackme 14:85a2ed029f37 184 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
dan_ackme 14:85a2ed029f37 185 <ul>
dan_ackme 14:85a2ed029f37 186 <li class="footer">&copy; ACKme Networks 2014</li>
dan_ackme 14:85a2ed029f37 187 </ul>
dan_ackme 14:85a2ed029f37 188 </div>
dan_ackme 14:85a2ed029f37 189 </body>
dan_ackme 14:85a2ed029f37 190 </html>