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/classwiconnect_1_1_file_interface.html
- Committer:
- aymangrais
- Date:
- 2015-09-28
- Revision:
- 42:8ffb253b09e7
- Parent:
- 29:b6af04b77a56
File content as of revision 42:8ffb253b09e7:
<!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 class="current"><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 id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></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('classwiconnect_1_1_file_interface.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="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="classwiconnect_1_1_file_interface-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">wiconnect::FileInterface Class Reference<div class="ingroups"><a class="el" href="group__api__file__types.html">Types</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>The provides an interface for creating TCP/UDP/TLS/HTTP client sockets. A client socket connects to a remote server.
<a href="classwiconnect_1_1_file_interface.html#details">More...</a></p>
<p><code>#include <<a class="el" href="_file_interface_8h_source.html">FileInterface.h</a>></code></p>
<p>Inherited by <a class="el" href="classwiconnect_1_1_wiconnect.html">wiconnect::Wiconnect</a>.</p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ga16fb09105975644879eb09581ce486e5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__file__methods.html#ga16fb09105975644879eb09581ce486e5">createFile</a> (const <a class="el" href="classwiconnect_1_1_reader_func.html">ReaderFunc</a> &reader, void *user, const char *name, uint32_t size, uint32_t version=0, <a class="el" href="group__api__file__types.html#ga9919a4237eea2b0d1f27c16d64e62c63">FileType</a> type=FILE_TYPE_ANY, bool isEssential=false, int32_t checksum=-1)</td></tr>
<tr class="memdesc:ga16fb09105975644879eb09581ce486e5"><td class="mdescLeft"> </td><td class="mdescRight">Create a file on the <a class="el" href="classwiconnect_1_1_wiconnect.html" title="The root WiConnect library class. This class inheriets all WiConnect functionality. ">Wiconnect</a> WiFi module filesystem. <a href="group__api__file__methods.html#ga16fb09105975644879eb09581ce486e5">More...</a><br /></td></tr>
<tr class="separator:ga16fb09105975644879eb09581ce486e5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaaf2977c691be09aeda102267a6769583"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__file__methods.html#gaaf2977c691be09aeda102267a6769583">openFile</a> (<a class="el" href="classwiconnect_1_1_wiconnect_file.html">WiconnectFile</a> &file, const char *name)</td></tr>
<tr class="memdesc:gaaf2977c691be09aeda102267a6769583"><td class="mdescLeft"> </td><td class="mdescRight">Open a file on the <a class="el" href="classwiconnect_1_1_wiconnect.html" title="The root WiConnect library class. This class inheriets all WiConnect functionality. ">Wiconnect</a> WiFi module filesystem for reading. <a href="group__api__file__methods.html#gaaf2977c691be09aeda102267a6769583">More...</a><br /></td></tr>
<tr class="separator:gaaf2977c691be09aeda102267a6769583"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gafcf335cef42b7b3d0fd9d5af70c6ef7d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__file__methods.html#gafcf335cef42b7b3d0fd9d5af70c6ef7d">deleteFile</a> (const char *name)</td></tr>
<tr class="memdesc:gafcf335cef42b7b3d0fd9d5af70c6ef7d"><td class="mdescLeft"> </td><td class="mdescRight">Delete a file for the <a class="el" href="classwiconnect_1_1_wiconnect.html" title="The root WiConnect library class. This class inheriets all WiConnect functionality. ">Wiconnect</a> WiFi module filesystem. <a href="group__api__file__methods.html#gafcf335cef42b7b3d0fd9d5af70c6ef7d">More...</a><br /></td></tr>
<tr class="separator:gafcf335cef42b7b3d0fd9d5af70c6ef7d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa9ea2d05871ee7e7bbfa360b86fefb20"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__file__methods.html#gaa9ea2d05871ee7e7bbfa360b86fefb20">deleteFile</a> (const <a class="el" href="classwiconnect_1_1_wiconnect_file.html">WiconnectFile</a> &file)</td></tr>
<tr class="memdesc:gaa9ea2d05871ee7e7bbfa360b86fefb20"><td class="mdescLeft"> </td><td class="mdescRight">Delete a file for the <a class="el" href="classwiconnect_1_1_wiconnect.html" title="The root WiConnect library class. This class inheriets all WiConnect functionality. ">Wiconnect</a> WiFi module filesystem. <a href="group__api__file__methods.html#gaa9ea2d05871ee7e7bbfa360b86fefb20">More...</a><br /></td></tr>
<tr class="separator:gaa9ea2d05871ee7e7bbfa360b86fefb20"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga10536639c61213c037883dade021838f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__file__methods.html#ga10536639c61213c037883dade021838f">listFiles</a> (<a class="el" href="classwiconnect_1_1_file_list.html">FileList</a> &list, const char *name=NULL, <a class="el" href="group__api__file__types.html#ga9919a4237eea2b0d1f27c16d64e62c63">FileType</a> type=FILE_TYPE_ANY, uint32_t version=0)</td></tr>
<tr class="memdesc:ga10536639c61213c037883dade021838f"><td class="mdescLeft"> </td><td class="mdescRight">List the files on the <a class="el" href="classwiconnect_1_1_wiconnect.html" title="The root WiConnect library class. This class inheriets all WiConnect functionality. ">Wiconnect</a> WiFi module filesystem. <a href="group__api__file__methods.html#ga10536639c61213c037883dade021838f">More...</a><br /></td></tr>
<tr class="separator:ga10536639c61213c037883dade021838f"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:gad74fbe6faf90d987b31380978f3ea341"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gad74fbe6faf90d987b31380978f3ea341"></a>
static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__conversion__util.html#gad74fbe6faf90d987b31380978f3ea341">fileVersionIntToStr</a> (uint32_t version, bool verbose=true, char *buffer=NULL)</td></tr>
<tr class="memdesc:gad74fbe6faf90d987b31380978f3ea341"><td class="mdescLeft"> </td><td class="mdescRight">Convert file version uint32 to string. <br /></td></tr>
<tr class="separator:gad74fbe6faf90d987b31380978f3ea341"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae995028f5a70c58ccf6013c9811e79aa"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gae995028f5a70c58ccf6013c9811e79aa"></a>
static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__conversion__util.html#gae995028f5a70c58ccf6013c9811e79aa">fileVersionStrToInt</a> (const char *versionStr, uint32_t *versionIntPtr)</td></tr>
<tr class="memdesc:gae995028f5a70c58ccf6013c9811e79aa"><td class="mdescLeft"> </td><td class="mdescRight">Convert string to file version uint32. <br /></td></tr>
<tr class="separator:gae995028f5a70c58ccf6013c9811e79aa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8d8da39cd5d2948367429ed4d8885c6b"><td class="memItemLeft" align="right" valign="top">static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__conversion__util.html#ga8d8da39cd5d2948367429ed4d8885c6b">fileTypeToStr</a> (<a class="el" href="group__api__file__types.html#ga9919a4237eea2b0d1f27c16d64e62c63">FileType</a> type)</td></tr>
<tr class="separator:ga8d8da39cd5d2948367429ed4d8885c6b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7503f1876a6e1f5086d8b4bb2c1a653a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga7503f1876a6e1f5086d8b4bb2c1a653a"></a>
static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__conversion__util.html#ga7503f1876a6e1f5086d8b4bb2c1a653a">fileFlagsToStr</a> (<a class="el" href="group__api__file__types.html#gafbe48908f5c190c3b0f272d3016e609e">FileFlags</a> flags, char *buffer=NULL)</td></tr>
<tr class="memdesc:ga7503f1876a6e1f5086d8b4bb2c1a653a"><td class="mdescLeft"> </td><td class="mdescRight">Convert <a class="el" href="group__api__file__types.html#gafbe48908f5c190c3b0f272d3016e609e">FileFlags</a> to string. <br /></td></tr>
<tr class="separator:ga7503f1876a6e1f5086d8b4bb2c1a653a"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The provides an interface for creating TCP/UDP/TLS/HTTP client sockets. A client socket connects to a remote server. </p>
<dl class="section note"><dt>Note</dt><dd>This class is an interface to the <a class="el" href="classwiconnect_1_1_wiconnect.html" title="The root WiConnect library class. This class inheriets all WiConnect functionality. ">Wiconnect</a> class. It should never be independently instantiated or the parent of another class. </dd></dl>
<p>Definition at line <a class="el" href="_file_interface_8h_source.html#l00068">68</a> of file <a class="el" href="_file_interface_8h_source.html">FileInterface.h</a>.</p>
</div><hr/>The documentation for this class was generated from the following file:<ul>
<li>C:/Users/reed/workspace/host-wiconnect/src/wiconnect/Wiconnect/api/<a class="el" href="_file_interface_8h_source.html">FileInterface.h</a></li>
</ul>
</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