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@10:735194df0097, 2014-08-11 (annotated)

Committer:
dan_ackme
Date:
Mon Aug 11 21:59:00 2014 -0700
Revision:
10:735194df0097
added doc files

Who changed what in which revision?

UserRevisionLine numberNew contents of line
dan_ackme 10:735194df0097 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
dan_ackme 10:735194df0097 2 <html xmlns="http://www.w3.org/1999/xhtml">
dan_ackme 10:735194df0097 3 <head>
dan_ackme 10:735194df0097 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
dan_ackme 10:735194df0097 5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
dan_ackme 10:735194df0097 6 <meta name="generator" content="Doxygen 1.8.7"/>
dan_ackme 10:735194df0097 7 <title>WiConnect Library: C:/Users/reed/workspace/host-wiconnect/src/wiconnect/Wiconnect/FileInterface.h Source File</title>
dan_ackme 10:735194df0097 8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
dan_ackme 10:735194df0097 9 <script type="text/javascript" src="jquery.js"></script>
dan_ackme 10:735194df0097 10 <script type="text/javascript" src="dynsections.js"></script>
dan_ackme 10:735194df0097 11 <link href="navtree.css" rel="stylesheet" type="text/css"/>
dan_ackme 10:735194df0097 12 <script type="text/javascript" src="resize.js"></script>
dan_ackme 10:735194df0097 13 <script type="text/javascript" src="navtree.js"></script>
dan_ackme 10:735194df0097 14 <script type="text/javascript">
dan_ackme 10:735194df0097 15 $(document).ready(initResizable);
dan_ackme 10:735194df0097 16 $(window).load(resizeHeight);
dan_ackme 10:735194df0097 17 </script>
dan_ackme 10:735194df0097 18 <link href="doxygen.css" rel="stylesheet" type="text/css" />
dan_ackme 10:735194df0097 19 </head>
dan_ackme 10:735194df0097 20 <body>
dan_ackme 10:735194df0097 21 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
dan_ackme 10:735194df0097 22 <div id="titlearea">
dan_ackme 10:735194df0097 23 <table cellspacing="0" cellpadding="0">
dan_ackme 10:735194df0097 24 <tbody>
dan_ackme 10:735194df0097 25 <tr style="height: 56px;">
dan_ackme 10:735194df0097 26 <td style="padding-left: 0.5em;">
dan_ackme 10:735194df0097 27 <div id="projectname">WiConnect Library
dan_ackme 10:735194df0097 28 </div>
dan_ackme 10:735194df0097 29 </td>
dan_ackme 10:735194df0097 30 </tr>
dan_ackme 10:735194df0097 31 </tbody>
dan_ackme 10:735194df0097 32 </table>
dan_ackme 10:735194df0097 33 </div>
dan_ackme 10:735194df0097 34 <!-- end header part -->
dan_ackme 10:735194df0097 35 <!-- Generated by Doxygen 1.8.7 -->
dan_ackme 10:735194df0097 36 <div id="navrow1" class="tabs">
dan_ackme 10:735194df0097 37 <ul class="tablist">
dan_ackme 10:735194df0097 38 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
dan_ackme 10:735194df0097 39 <li><a href="modules.html"><span>Modules</span></a></li>
dan_ackme 10:735194df0097 40 <li><a href="annotated.html"><span>Classes</span></a></li>
dan_ackme 10:735194df0097 41 <li class="current"><a href="files.html"><span>Files</span></a></li>
dan_ackme 10:735194df0097 42 </ul>
dan_ackme 10:735194df0097 43 </div>
dan_ackme 10:735194df0097 44 <div id="navrow2" class="tabs2">
dan_ackme 10:735194df0097 45 <ul class="tablist">
dan_ackme 10:735194df0097 46 <li><a href="files.html"><span>File&#160;List</span></a></li>
dan_ackme 10:735194df0097 47 </ul>
dan_ackme 10:735194df0097 48 </div>
dan_ackme 10:735194df0097 49 </div><!-- top -->
dan_ackme 10:735194df0097 50 <div id="side-nav" class="ui-resizable side-nav-resizable">
dan_ackme 10:735194df0097 51 <div id="nav-tree">
dan_ackme 10:735194df0097 52 <div id="nav-tree-contents">
dan_ackme 10:735194df0097 53 <div id="nav-sync" class="sync"></div>
dan_ackme 10:735194df0097 54 </div>
dan_ackme 10:735194df0097 55 </div>
dan_ackme 10:735194df0097 56 <div id="splitbar" style="-moz-user-select:none;"
dan_ackme 10:735194df0097 57 class="ui-resizable-handle">
dan_ackme 10:735194df0097 58 </div>
dan_ackme 10:735194df0097 59 </div>
dan_ackme 10:735194df0097 60 <script type="text/javascript">
dan_ackme 10:735194df0097 61 $(document).ready(function(){initNavTree('_file_interface_8h_source.html','');});
dan_ackme 10:735194df0097 62 </script>
dan_ackme 10:735194df0097 63 <div id="doc-content">
dan_ackme 10:735194df0097 64 <div class="header">
dan_ackme 10:735194df0097 65 <div class="headertitle">
dan_ackme 10:735194df0097 66 <div class="title">FileInterface.h</div> </div>
dan_ackme 10:735194df0097 67 </div><!--header-->
dan_ackme 10:735194df0097 68 <div class="contents">
dan_ackme 10:735194df0097 69 <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div>
dan_ackme 10:735194df0097 70 <div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * Copyright 2014, ACKme Networks</span></div>
dan_ackme 10:735194df0097 71 <div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> * All Rights Reserved.</span></div>
dan_ackme 10:735194df0097 72 <div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> *</span></div>
dan_ackme 10:735194df0097 73 <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 10:735194df0097 74 <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 10:735194df0097 75 <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 10:735194df0097 76 <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 10:735194df0097 77 <div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> */</span></div>
dan_ackme 10:735194df0097 78 <div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;</div>
dan_ackme 10:735194df0097 79 <div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor">#pragma once</span></div>
dan_ackme 10:735194df0097 80 <div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;</div>
dan_ackme 10:735194df0097 81 <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 10:735194df0097 82 <div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;</div>
dan_ackme 10:735194df0097 83 <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 10:735194df0097 84 <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 10:735194df0097 85 <div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;</div>
dan_ackme 10:735194df0097 86 <div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;</div>
dan_ackme 10:735194df0097 87 <div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#define FILE_NAME_MAX_SIZE 96</span></div>
dan_ackme 10:735194df0097 88 <div class="line"><a name="l00020"></a><span class="lineno"> 20</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 10:735194df0097 89 <div class="line"><a name="l00021"></a><span class="lineno"> 21</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 10:735194df0097 90 <div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;</div>
dan_ackme 10:735194df0097 91 <div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;</div>
dan_ackme 10:735194df0097 92 <div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="keyword">namespace </span>wiconnect {</div>
dan_ackme 10:735194df0097 93 <div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;</div>
dan_ackme 10:735194df0097 94 <div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;</div>
dan_ackme 10:735194df0097 95 <div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="keyword">class </span>FileInterface</div>
dan_ackme 10:735194df0097 96 <div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;{</div>
dan_ackme 10:735194df0097 97 <div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="keyword">public</span>:</div>
dan_ackme 10:735194df0097 98 <div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; WiconnectResult createFile(<span class="keyword">const</span> ReaderFunc &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, FileType type = FILE_TYPE_ANY, <span class="keywordtype">bool</span> isEssential = <span class="keyword">false</span>, int32_t checksum = -1);</div>
dan_ackme 10:735194df0097 99 <div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; WiconnectResult openFile(File &amp;file, <span class="keyword">const</span> <span class="keywordtype">char</span> *name);</div>
dan_ackme 10:735194df0097 100 <div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; WiconnectResult deleteFile(<span class="keyword">const</span> <span class="keywordtype">char</span> *name);</div>
dan_ackme 10:735194df0097 101 <div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; WiconnectResult deleteFile(<span class="keyword">const</span> File &amp;file);</div>
dan_ackme 10:735194df0097 102 <div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; WiconnectResult listFiles(FileList &amp;list, <span class="keyword">const</span> <span class="keywordtype">char</span> *name = NULL, FileType type = FILE_TYPE_ANY, uint32_t version = 0);</div>
dan_ackme 10:735194df0097 103 <div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;</div>
dan_ackme 10:735194df0097 104 <div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* fileVersionIntToStr(uint32_t version, <span class="keywordtype">bool</span> verbose = <span class="keyword">true</span>, <span class="keywordtype">char</span> *buffer = NULL);</div>
dan_ackme 10:735194df0097 105 <div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> fileVersionStrToInt(<span class="keyword">const</span> <span class="keywordtype">char</span> *versionStr, uint32_t *versionIntPtr);</div>
dan_ackme 10:735194df0097 106 <div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* fileTypeToStr(FileType type);</div>
dan_ackme 10:735194df0097 107 <div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* fileFlagsToStr(FileFlags flags, <span class="keywordtype">char</span> *buffer = NULL);</div>
dan_ackme 10:735194df0097 108 <div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;</div>
dan_ackme 10:735194df0097 109 <div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="keyword">protected</span>:</div>
dan_ackme 10:735194df0097 110 <div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; FileInterface(Wiconnect *wiconnect);</div>
dan_ackme 10:735194df0097 111 <div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;</div>
dan_ackme 10:735194df0097 112 <div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; WiconnectResult processFileList(<span class="keywordtype">char</span> *responseStr, FileList &amp;list, <span class="keyword">const</span> <span class="keywordtype">char</span> *name, FileType type, uint32_t version);</div>
dan_ackme 10:735194df0097 113 <div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<span class="keyword">private</span>:</div>
dan_ackme 10:735194df0097 114 <div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; Wiconnect *wiconnect;</div>
dan_ackme 10:735194df0097 115 <div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;};</div>
dan_ackme 10:735194df0097 116 <div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;</div>
dan_ackme 10:735194df0097 117 <div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;}</div>
dan_ackme 10:735194df0097 118 </div><!-- fragment --></div><!-- contents -->
dan_ackme 10:735194df0097 119 </div><!-- doc-content -->
dan_ackme 10:735194df0097 120 <!-- start footer part -->
dan_ackme 10:735194df0097 121 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
dan_ackme 10:735194df0097 122 <ul>
dan_ackme 10:735194df0097 123 <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_2cefe8a608dd77002e2a359719ab297e.html">wiconnect</a></li><li class="navelem"><a class="el" href="dir_cd3afd97bddf83876771aca0b74624b0.html">Wiconnect</a></li><li class="navelem"><b>FileInterface.h</b></li>
dan_ackme 10:735194df0097 124 <li class="footer">Generated on Mon Aug 11 2014 21:58:23 for WiConnect Library by
dan_ackme 10:735194df0097 125 <a href="http://www.doxygen.org/index.html">
dan_ackme 10:735194df0097 126 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.7 </li>
dan_ackme 10:735194df0097 127 </ul>
dan_ackme 10:735194df0097 128 </div>
dan_ackme 10:735194df0097 129 </body>
dan_ackme 10:735194df0097 130 </html>