ACKme
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
- Committer:
- dan_ackme
- Date:
- 2014-08-13
- Revision:
- 16:7f1d6d359787
- Parent:
- 14:85a2ed029f37
- Child:
- 17:7268f365676b
File content as of revision 16:7f1d6d359787:
<!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/1.2/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('_file_interface_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">FileInterface.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> </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> <span class="preprocessor">#include "types/FileList.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> </div>
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="group__api__file__macro.html#gaa124c352091337449140487b9f9db040"> 40</a></span> <span class="preprocessor">#define FILE_NAME_MAX_SIZE 96</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div>
<div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="group__api__file__macro.html#gac39210b86d0465e494a6d0d56cf8dd05"> 47</a></span> <span class="preprocessor">#define FILE_MAKE_VERSION(major, minor, patch, rc) ((unsigned int)((major) << 27)|(unsigned int)((minor) << 21)|(unsigned int)((patch) << 8)|(unsigned int)((rc) << 0))</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div>
<div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="group__api__file__macro.html#ga132e94ace044130d574117ac13c7fd24"> 53</a></span> <span class="preprocessor">#define FILE_VERSION_ARGS(version) (unsigned int)((version >> 27) & 0x1F),(unsigned int)((version >> 21) & 0x3F),(unsigned int)((version >> 8) & 0x1FFF),(unsigned int)(version & 0xFF)</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> </div>
<div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="namespacewiconnect.html"> 56</a></span> <span class="keyword">namespace </span>wiconnect {</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="l00068"></a><span class="lineno"><a class="line" href="classwiconnect_1_1_file_interface.html"> 68</a></span> <span class="keyword">class </span><a class="code" href="classwiconnect_1_1_file_interface.html">FileInterface</a></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="keyword">public</span>:</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <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> &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>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</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> <a class="code" href="group__api__file__methods.html#ga4b14d6c68d4d0239e150def385c334a4">openFile</a>(<a class="code" href="classwiconnect_1_1_file.html">File</a> &file, <span class="keyword">const</span> <span class="keywordtype">char</span> *name);</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> </div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <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>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span> </div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  <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> &file);</div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span> </div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  <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> &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>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span> </div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span> </div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  <span class="comment">// ------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span> </div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span> </div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  <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>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span> </div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span>  <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>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span> </div>
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span>  <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>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span> </div>
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span>  <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>
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span> </div>
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span> <span class="keyword">protected</span>:</div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span>  <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>
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span> </div>
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span>  <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> &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>
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span> <span class="keyword">private</span>:</div>
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span>  <a class="code" href="classwiconnect_1_1_wiconnect.html">Wiconnect</a> *wiconnect;</div>
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span> };</div>
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span> </div>
<div class="line"><a name="l00187"></a><span class="lineno"> 187</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="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>
<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>
<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 &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>
<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_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#l00045">ReaderFunc.h:45</a></div></div>
<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 &file, const char *name)</div><div class="ttdoc">Open a file on the Wiconnect WiFi module filesystem for reading. </div></div>
<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>
<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#l00351">WiconnectTypes.h:351</a></div></div>
<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 &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>
<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>
<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#l00332">WiconnectTypes.h:332</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_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 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>
</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>
Repository toolbox
| Export to desktop IDE |
Repository details
| Type: | Library |
|---|---|
| Created: | 11 Aug 2014 |
| Imports: | 190 |
| Forks: | 0 |
| Commits: | 43 |
| Dependents: | 10 |
| Dependencies: | 0 |
| Followers: | 25 |
Components
AMW006-A02