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

Diff: doc/html/classwiconnect_1_1_file_interface.html

Revision:
11:ea484e1b7fc4
Child:
13:2b51f5267c92
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/html/classwiconnect_1_1_file_interface.html	Tue Aug 12 02:34:46 2014 -0700
@@ -0,0 +1,179 @@
+<!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"/>
+<meta name="generator" content="Doxygen 1.8.7"/>
+<title>WiConnect Library: wiconnect::FileInterface Class Reference</title>
+<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">
+<table cellspacing="0" cellpadding="0">
+ <tbody>
+ <tr style="height: 56px;">
+  <td style="padding-left: 0.5em;">
+   <div id="projectname">WiConnect Library
+   </div>
+  </td>
+ </tr>
+ </tbody>
+</table>
+</div>
+<!-- end header part -->
+<!-- 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>Main&#160;Page</span></a></li>
+      <li><a href="modules.html"><span>Modules</span></a></li>
+      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
+      <li class="current"><a href="annotated.html"><span>Classes</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&#160;List</span></a></li>
+      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
+      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
+      <li><a href="functions.html"><span>Class&#160;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">&#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>
+
+<!-- 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> &#124;
+<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
+<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__types__file.html">File API</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 &lt;FileInterface.h&gt;</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="anchor" id="ga16fb09105975644879eb09581ce486e5"></a>
+<a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__file.html#ga16fb09105975644879eb09581ce486e5">createFile</a> (const <a class="el" href="classwiconnect_1_1_reader_func.html">ReaderFunc</a> &amp;reader, void *user, const char *name, uint32_t size, uint32_t version=0, <a class="el" href="group__types__file.html#ga9919a4237eea2b0d1f27c16d64e62c63">FileType</a> type=FILE_TYPE_ANY, bool isEssential=false, int32_t checksum=-1)</td></tr>
+<tr class="memdesc:ga16fb09105975644879eb09581ce486e5"><td class="mdescLeft">&#160;</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 flash filesystem. <br /></td></tr>
+<tr class="separator:ga16fb09105975644879eb09581ce486e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga4b14d6c68d4d0239e150def385c334a4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga4b14d6c68d4d0239e150def385c334a4"></a>
+<a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__file.html#ga4b14d6c68d4d0239e150def385c334a4">openFile</a> (<a class="el" href="classwiconnect_1_1_file.html">File</a> &amp;file, const char *name)</td></tr>
+<tr class="memdesc:ga4b14d6c68d4d0239e150def385c334a4"><td class="mdescLeft">&#160;</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 flash filesystem for reading. <br /></td></tr>
+<tr class="separator:ga4b14d6c68d4d0239e150def385c334a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:gafcf335cef42b7b3d0fd9d5af70c6ef7d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gafcf335cef42b7b3d0fd9d5af70c6ef7d"></a>
+<a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__file.html#gafcf335cef42b7b3d0fd9d5af70c6ef7d">deleteFile</a> (const char *name)</td></tr>
+<tr class="memdesc:gafcf335cef42b7b3d0fd9d5af70c6ef7d"><td class="mdescLeft">&#160;</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 flash filesystem. <br /></td></tr>
+<tr class="separator:gafcf335cef42b7b3d0fd9d5af70c6ef7d"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga498cb32c0877b69c2c97365e5c309c46"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga498cb32c0877b69c2c97365e5c309c46"></a>
+<a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__file.html#ga498cb32c0877b69c2c97365e5c309c46">deleteFile</a> (const <a class="el" href="classwiconnect_1_1_file.html">File</a> &amp;file)</td></tr>
+<tr class="memdesc:ga498cb32c0877b69c2c97365e5c309c46"><td class="mdescLeft">&#160;</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 flash filesystem. <br /></td></tr>
+<tr class="separator:ga498cb32c0877b69c2c97365e5c309c46"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga10536639c61213c037883dade021838f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga10536639c61213c037883dade021838f"></a>
+<a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__file.html#ga10536639c61213c037883dade021838f">listFiles</a> (<a class="el" href="classwiconnect_1_1_file_list.html">FileList</a> &amp;list, const char *name=NULL, <a class="el" href="group__types__file.html#ga9919a4237eea2b0d1f27c16d64e62c63">FileType</a> type=FILE_TYPE_ANY, uint32_t version=0)</td></tr>
+<tr class="memdesc:ga10536639c61213c037883dade021838f"><td class="mdescLeft">&#160;</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 flash filesystem. <br /></td></tr>
+<tr class="separator:ga10536639c61213c037883dade021838f"><td class="memSeparator" colspan="2">&#160;</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 *&#160;</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">&#160;</td><td class="mdescRight">Convert file version uint32 to string. <br /></td></tr>
+<tr class="separator:gad74fbe6faf90d987b31380978f3ea341"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:gae995028f5a70c58ccf6013c9811e79aa"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gae995028f5a70c58ccf6013c9811e79aa"></a>
+static bool&#160;</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">&#160;</td><td class="mdescRight">Convert string to file version uint32. <br /></td></tr>
+<tr class="separator:gae995028f5a70c58ccf6013c9811e79aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga8d8da39cd5d2948367429ed4d8885c6b"><td class="memItemLeft" align="right" valign="top">static const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__conversion__util.html#ga8d8da39cd5d2948367429ed4d8885c6b">fileTypeToStr</a> (<a class="el" href="group__types__file.html#ga9919a4237eea2b0d1f27c16d64e62c63">FileType</a> type)</td></tr>
+<tr class="separator:ga8d8da39cd5d2948367429ed4d8885c6b"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga7503f1876a6e1f5086d8b4bb2c1a653a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga7503f1876a6e1f5086d8b4bb2c1a653a"></a>
+static const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__conversion__util.html#ga7503f1876a6e1f5086d8b4bb2c1a653a">fileFlagsToStr</a> (<a class="el" href="group__types__file.html#gafbe48908f5c190c3b0f272d3016e609e">FileFlags</a> flags, char *buffer=NULL)</td></tr>
+<tr class="memdesc:ga7503f1876a6e1f5086d8b4bb2c1a653a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert <a class="el" href="group__types__file.html#gafbe48908f5c190c3b0f272d3016e609e">FileFlags</a> to string. <br /></td></tr>
+<tr class="separator:ga7503f1876a6e1f5086d8b4bb2c1a653a"><td class="memSeparator" colspan="2">&#160;</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>
+</div><hr/>The documentation for this class was generated from the following file:<ul>
+<li>C:/Users/reed/workspace/host-wiconnect/src/wiconnect/Wiconnect/FileInterface.h</li>
+</ul>
+</div><!-- contents -->
+</div><!-- doc-content -->
+<!-- start footer part -->
+<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
+  <ul>
+    <li class="navelem"><a class="el" href="namespacewiconnect.html">wiconnect</a></li><li class="navelem"><a class="el" href="classwiconnect_1_1_file_interface.html">FileInterface</a></li>
+    <li class="footer">Generated on Tue Aug 12 2014 02:15:24 for WiConnect Library by
+    <a href="http://www.doxygen.org/index.html">
+    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.7 </li>
+  </ul>
+</div>
+</body>
+</html>