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/group__types__file.html
- Revision:
- 16:7f1d6d359787
- Parent:
- 15:d3cd02b201e1
- Child:
- 17:7268f365676b
--- a/doc/html/group__types__file.html Wed Aug 13 03:15:49 2014 -0700 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,268 +0,0 @@ -<!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: File API</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 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><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><!-- 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('group__types__file.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="#nested-classes">Classes</a> | -<a href="#enum-members">Enumerations</a> </div> - <div class="headertitle"> -<div class="title">File API<div class="ingroups"><a class="el" href="group__types.html">Types</a></div></div> </div> -</div><!--header--> -<div class="contents"> - -<p>File API Types. -<a href="#details">More...</a></p> -<table class="memberdecls"> -<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> -Classes</h2></td></tr> -<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classwiconnect_1_1_file_interface.html">wiconnect::FileInterface</a></td></tr> -<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">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><br /></td></tr> -<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classwiconnect_1_1_file.html">wiconnect::File</a></td></tr> -<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">WiConnect WiFi module file object. <a href="classwiconnect_1_1_file.html#details">More...</a><br /></td></tr> -<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classwiconnect_1_1_file_list.html">wiconnect::FileList</a></td></tr> -<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">WiConnect WiFi module file listing. <a href="classwiconnect_1_1_file_list.html#details">More...</a><br /></td></tr> -<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> -</table><table class="memberdecls"> -<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a> -Enumerations</h2></td></tr> -<tr class="memitem:gafbe48908f5c190c3b0f272d3016e609e"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__types__file.html#gafbe48908f5c190c3b0f272d3016e609e">wiconnect::FileFlags</a> { <br /> -  <a class="el" href="group__types__file.html#ggafbe48908f5c190c3b0f272d3016e609eac40bade251c1d671283d3ab2515725a6">wiconnect::FILE_FLAG_NONE</a> = 0, -<a class="el" href="group__types__file.html#ggafbe48908f5c190c3b0f272d3016e609eaff56da02ac3626bf5636e0aa6ffff78a">wiconnect::FILE_FLAG_VALID</a> = (1 << 0), -<a class="el" href="group__types__file.html#ggafbe48908f5c190c3b0f272d3016e609ea94ddbab88df5f29013d5deb3f3d092c5">wiconnect::FILE_FLAG_EXECUTABLE</a> = (1 << 1), -<a class="el" href="group__types__file.html#ggafbe48908f5c190c3b0f272d3016e609ea07f098f34c015d1c81d7592b476312e6">wiconnect::FILE_FLAG_ENCRYPTED</a> = (1 << 2), -<br /> -  <a class="el" href="group__types__file.html#ggafbe48908f5c190c3b0f272d3016e609eaad3ddfddf9e28a26df73b689e0898df0">wiconnect::FILE_FLAG_INTERNAL</a> = (1 << 3), -<a class="el" href="group__types__file.html#ggafbe48908f5c190c3b0f272d3016e609eaffe90e6784ad43acffbf823502a6a7bf">wiconnect::FILE_FLAG_BOOTABLE</a> = (1 << 4), -<a class="el" href="group__types__file.html#ggafbe48908f5c190c3b0f272d3016e609ea3864357fd0b63b4cd6594d00c2194ca8">wiconnect::FILE_FLAG_USER</a> = (1 << 5), -<a class="el" href="group__types__file.html#ggafbe48908f5c190c3b0f272d3016e609eaa74f44cd76d69e9f32d70a2b13c8c4e2">wiconnect::FILE_FLAG_ESSENTIAL</a> = (1 << 6), -<br /> -  <a class="el" href="group__types__file.html#ggafbe48908f5c190c3b0f272d3016e609ea21f35fd8f0a4e38d91d5d1f5c5cc977f">wiconnect::FILE_FLAG_INVALID</a> = 0xFFFF -<br /> - }</td></tr> -<tr class="memdesc:gafbe48908f5c190c3b0f272d3016e609e"><td class="mdescLeft"> </td><td class="mdescRight">File flags type. <a href="group__types__file.html#gafbe48908f5c190c3b0f272d3016e609e">More...</a><br /></td></tr> -<tr class="separator:gafbe48908f5c190c3b0f272d3016e609e"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga9919a4237eea2b0d1f27c16d64e62c63"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__types__file.html#ga9919a4237eea2b0d1f27c16d64e62c63">wiconnect::FileType</a> { <br /> -  <a class="el" href="group__types__file.html#gga9919a4237eea2b0d1f27c16d64e62c63ac2bf941d4f7f23cabf7c781c5741dc04">wiconnect::FILE_TYPE_UPGRADE_APP</a> = 0x00, -<a class="el" href="group__types__file.html#gga9919a4237eea2b0d1f27c16d64e62c63ad127cd0d4eeefee993a24b4d5095bfe7">wiconnect::FILE_TYPE_WIFI_FW</a> = 0x01, -<a class="el" href="group__types__file.html#gga9919a4237eea2b0d1f27c16d64e62c63a681a5a935adbd3aefdbb3639c36a4169">wiconnect::FILE_TYPE_REGULAR_APP</a> = 0x81, -<a class="el" href="group__types__file.html#gga9919a4237eea2b0d1f27c16d64e62c63a2271e7ab227bf95699c260a258902eeb">wiconnect::FILE_TYPE_USER_RANGE_START</a> = 150, -<br /> -  <a class="el" href="group__types__file.html#gga9919a4237eea2b0d1f27c16d64e62c63a2958dab5107b78cd1c14400770ab9b4e">wiconnect::FILE_TYPE_USER_RANGE_END</a> = 199, -<a class="el" href="group__types__file.html#gga9919a4237eea2b0d1f27c16d64e62c63aaa4d15bf30361c1026fe15e029e9c3e2">wiconnect::FILE_TYPE_TEMPORY</a> = 0xF9, -<a class="el" href="group__types__file.html#gga9919a4237eea2b0d1f27c16d64e62c63a5df6fc01411942aabcf83731d0d02d52">wiconnect::FILE_TYPE_GPIO_CONFIG</a> = 0xFA, -<a class="el" href="group__types__file.html#gga9919a4237eea2b0d1f27c16d64e62c63a35624c078c19b7b632d832d15c0d1ef0">wiconnect::FILE_TYPE_COMMAND_HELP</a> = 0xFB, -<br /> -  <a class="el" href="group__types__file.html#gga9919a4237eea2b0d1f27c16d64e62c63a244c4ea312de84a2f4cabaff386fcffd">wiconnect::FILE_TYPE_SDC_CAPS</a> = 0xFC, -<a class="el" href="group__types__file.html#gga9919a4237eea2b0d1f27c16d64e62c63afd6c376410552b54187a162e2c6fdad2">wiconnect::FILE_TYPE_SETUP_SCRIPT</a> = 0xFD, -<a class="el" href="group__types__file.html#gga9919a4237eea2b0d1f27c16d64e62c63a2508195aa2793d49c5c6a24879b52206">wiconnect::FILE_TYPE_MISC_FIX_LEN</a> = 0xFE, -<a class="el" href="group__types__file.html#gga9919a4237eea2b0d1f27c16d64e62c63a077782e07756b6dc93f96e9a0cca5c9e">wiconnect::FILE_TYPE_UNKNOWN</a> = 0xFF -<br /> - }</td></tr> -<tr class="memdesc:ga9919a4237eea2b0d1f27c16d64e62c63"><td class="mdescLeft"> </td><td class="mdescRight">File type type. <a href="group__types__file.html#ga9919a4237eea2b0d1f27c16d64e62c63">More...</a><br /></td></tr> -<tr class="separator:ga9919a4237eea2b0d1f27c16d64e62c63"><td class="memSeparator" colspan="2"> </td></tr> -</table> -<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> -<p>File API Types. </p> -<h2 class="groupheader">Enumeration Type Documentation</h2> -<a class="anchor" id="gafbe48908f5c190c3b0f272d3016e609e"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">enum <a class="el" href="group__types__file.html#gafbe48908f5c190c3b0f272d3016e609e">wiconnect::FileFlags</a></td> - </tr> - </table> -</div><div class="memdoc"> - -<p><a class="el" href="classwiconnect_1_1_file.html" title="WiConnect WiFi module file object. ">File</a> flags type. </p> -<table class="fieldtable"> -<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="ggafbe48908f5c190c3b0f272d3016e609eac40bade251c1d671283d3ab2515725a6"></a>FILE_FLAG_NONE </td><td class="fielddoc"> -<p>No flags. </p> -</td></tr> -<tr><td class="fieldname"><a class="anchor" id="ggafbe48908f5c190c3b0f272d3016e609eaff56da02ac3626bf5636e0aa6ffff78a"></a>FILE_FLAG_VALID </td><td class="fielddoc"> -<p><a class="el" href="classwiconnect_1_1_file.html" title="WiConnect WiFi module file object. ">File</a> valid. </p> -</td></tr> -<tr><td class="fieldname"><a class="anchor" id="ggafbe48908f5c190c3b0f272d3016e609ea94ddbab88df5f29013d5deb3f3d092c5"></a>FILE_FLAG_EXECUTABLE </td><td class="fielddoc"> -<p><a class="el" href="classwiconnect_1_1_file.html" title="WiConnect WiFi module file object. ">File</a> executable. </p> -</td></tr> -<tr><td class="fieldname"><a class="anchor" id="ggafbe48908f5c190c3b0f272d3016e609ea07f098f34c015d1c81d7592b476312e6"></a>FILE_FLAG_ENCRYPTED </td><td class="fielddoc"> -<p><a class="el" href="classwiconnect_1_1_file.html" title="WiConnect WiFi module file object. ">File</a> encrypted. </p> -</td></tr> -<tr><td class="fieldname"><a class="anchor" id="ggafbe48908f5c190c3b0f272d3016e609eaad3ddfddf9e28a26df73b689e0898df0"></a>FILE_FLAG_INTERNAL </td><td class="fielddoc"> -<p><a class="el" href="classwiconnect_1_1_file.html" title="WiConnect WiFi module file object. ">File</a> on internal module flash. </p> -</td></tr> -<tr><td class="fieldname"><a class="anchor" id="ggafbe48908f5c190c3b0f272d3016e609eaffe90e6784ad43acffbf823502a6a7bf"></a>FILE_FLAG_BOOTABLE </td><td class="fielddoc"> -<p><a class="el" href="classwiconnect_1_1_file.html" title="WiConnect WiFi module file object. ">File</a> bootable. </p> -</td></tr> -<tr><td class="fieldname"><a class="anchor" id="ggafbe48908f5c190c3b0f272d3016e609ea3864357fd0b63b4cd6594d00c2194ca8"></a>FILE_FLAG_USER </td><td class="fielddoc"> -<p><a class="el" href="classwiconnect_1_1_file.html" title="WiConnect WiFi module file object. ">File</a> created by user. </p> -</td></tr> -<tr><td class="fieldname"><a class="anchor" id="ggafbe48908f5c190c3b0f272d3016e609eaa74f44cd76d69e9f32d70a2b13c8c4e2"></a>FILE_FLAG_ESSENTIAL </td><td class="fielddoc"> -<p><a class="el" href="classwiconnect_1_1_file.html" title="WiConnect WiFi module file object. ">File</a> is essential. </p> -</td></tr> -<tr><td class="fieldname"><a class="anchor" id="ggafbe48908f5c190c3b0f272d3016e609ea21f35fd8f0a4e38d91d5d1f5c5cc977f"></a>FILE_FLAG_INVALID </td><td class="fielddoc"> -<p><a class="el" href="classwiconnect_1_1_file.html" title="WiConnect WiFi module file object. ">File</a> flags invalid. </p> -</td></tr> -</table> - -</div> -</div> -<a class="anchor" id="ga9919a4237eea2b0d1f27c16d64e62c63"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">enum <a class="el" href="group__types__file.html#ga9919a4237eea2b0d1f27c16d64e62c63">wiconnect::FileType</a></td> - </tr> - </table> -</div><div class="memdoc"> - -<p><a class="el" href="classwiconnect_1_1_file.html" title="WiConnect WiFi module file object. ">File</a> type type. </p> -<table class="fieldtable"> -<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="gga9919a4237eea2b0d1f27c16d64e62c63ac2bf941d4f7f23cabf7c781c5741dc04"></a>FILE_TYPE_UPGRADE_APP </td><td class="fielddoc"> -<p>Internal upgrade application. </p> -</td></tr> -<tr><td class="fieldname"><a class="anchor" id="gga9919a4237eea2b0d1f27c16d64e62c63ad127cd0d4eeefee993a24b4d5095bfe7"></a>FILE_TYPE_WIFI_FW </td><td class="fielddoc"> -<p>Wifi firmware binary. </p> -</td></tr> -<tr><td class="fieldname"><a class="anchor" id="gga9919a4237eea2b0d1f27c16d64e62c63a681a5a935adbd3aefdbb3639c36a4169"></a>FILE_TYPE_REGULAR_APP </td><td class="fielddoc"> -<p>Regular application. </p> -</td></tr> -<tr><td class="fieldname"><a class="anchor" id="gga9919a4237eea2b0d1f27c16d64e62c63a2271e7ab227bf95699c260a258902eeb"></a>FILE_TYPE_USER_RANGE_START </td><td class="fielddoc"> -<p>User type start index. </p> -</td></tr> -<tr><td class="fieldname"><a class="anchor" id="gga9919a4237eea2b0d1f27c16d64e62c63a2958dab5107b78cd1c14400770ab9b4e"></a>FILE_TYPE_USER_RANGE_END </td><td class="fielddoc"> -<p>User type end index. </p> -</td></tr> -<tr><td class="fieldname"><a class="anchor" id="gga9919a4237eea2b0d1f27c16d64e62c63aaa4d15bf30361c1026fe15e029e9c3e2"></a>FILE_TYPE_TEMPORY </td><td class="fielddoc"> -<p>Temporary file. </p> -</td></tr> -<tr><td class="fieldname"><a class="anchor" id="gga9919a4237eea2b0d1f27c16d64e62c63a5df6fc01411942aabcf83731d0d02d52"></a>FILE_TYPE_GPIO_CONFIG </td><td class="fielddoc"> -<p>GPIO configuration file. </p> -</td></tr> -<tr><td class="fieldname"><a class="anchor" id="gga9919a4237eea2b0d1f27c16d64e62c63a35624c078c19b7b632d832d15c0d1ef0"></a>FILE_TYPE_COMMAND_HELP </td><td class="fielddoc"> -<p>WiConnect command help file. </p> -</td></tr> -<tr><td class="fieldname"><a class="anchor" id="gga9919a4237eea2b0d1f27c16d64e62c63a244c4ea312de84a2f4cabaff386fcffd"></a>FILE_TYPE_SDC_CAPS </td><td class="fielddoc"> -<p>SDC / goHACK.me file. </p> -</td></tr> -<tr><td class="fieldname"><a class="anchor" id="gga9919a4237eea2b0d1f27c16d64e62c63afd6c376410552b54187a162e2c6fdad2"></a>FILE_TYPE_SETUP_SCRIPT </td><td class="fielddoc"> -<p>Setup script file. </p> -</td></tr> -<tr><td class="fieldname"><a class="anchor" id="gga9919a4237eea2b0d1f27c16d64e62c63a2508195aa2793d49c5c6a24879b52206"></a>FILE_TYPE_MISC_FIX_LEN </td><td class="fielddoc"> -<p>Miscellaneous fixed length file. </p> -</td></tr> -<tr><td class="fieldname"><a class="anchor" id="gga9919a4237eea2b0d1f27c16d64e62c63a077782e07756b6dc93f96e9a0cca5c9e"></a>FILE_TYPE_UNKNOWN </td><td class="fielddoc"> -<p>Unknown file type. </p> -</td></tr> -</table> - -</div> -</div> -</div><!-- contents --> -</div><!-- doc-content --> -<!-- start footer part --> -<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> - <ul> - <li class="footer">Generated on Tue Aug 12 2014 02:15:23 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>