structlws__plat__file__ops.html 8.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.11"/>
  7. <title>libwebsockets: lws_plat_file_ops Struct Reference</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="navtree.css" rel="stylesheet" type="text/css"/>
  12. <script type="text/javascript" src="resize.js"></script>
  13. <script type="text/javascript" src="navtreedata.js"></script>
  14. <script type="text/javascript" src="navtree.js"></script>
  15. <script type="text/javascript">
  16. $(document).ready(initResizable);
  17. $(window).load(resizeHeight);
  18. </script>
  19. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  20. </head>
  21. <body>
  22. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  23. <div id="titlearea">
  24. <table cellspacing="0" cellpadding="0">
  25. <tbody>
  26. <tr style="height: 56px;">
  27. <td id="projectlogo"><img alt="Logo" src="libwebsockets.org-logo.png"/></td>
  28. <td id="projectalign" style="padding-left: 0.5em;">
  29. <div id="projectname">libwebsockets
  30. </div>
  31. <div id="projectbrief">Lightweight C library for HTML5 websockets</div>
  32. </td>
  33. </tr>
  34. </tbody>
  35. </table>
  36. </div>
  37. <!-- end header part -->
  38. <!-- Generated by Doxygen 1.8.11 -->
  39. <div id="navrow1" class="tabs">
  40. <ul class="tablist">
  41. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  42. <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  43. <li><a href="modules.html"><span>Modules</span></a></li>
  44. <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  45. <li><a href="files.html"><span>Files</span></a></li>
  46. </ul>
  47. </div>
  48. <div id="navrow2" class="tabs2">
  49. <ul class="tablist">
  50. <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  51. <li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
  52. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  53. <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
  54. </ul>
  55. </div>
  56. </div><!-- top -->
  57. <div id="side-nav" class="ui-resizable side-nav-resizable">
  58. <div id="nav-tree">
  59. <div id="nav-tree-contents">
  60. <div id="nav-sync" class="sync"></div>
  61. </div>
  62. </div>
  63. <div id="splitbar" style="-moz-user-select:none;"
  64. class="ui-resizable-handle">
  65. </div>
  66. </div>
  67. <script type="text/javascript">
  68. $(document).ready(function(){initNavTree('structlws__plat__file__ops.html','');});
  69. </script>
  70. <div id="doc-content">
  71. <div class="header">
  72. <div class="summary">
  73. <a href="#pub-attribs">Data Fields</a> </div>
  74. <div class="headertitle">
  75. <div class="title">lws_plat_file_ops Struct Reference<div class="ingroups"><a class="el" href="group__fops.html">file operation wrapping</a></div></div> </div>
  76. </div><!--header-->
  77. <div class="contents">
  78. <p><code>#include &lt;<a class="el" href="libwebsockets_8h_source.html">libwebsockets.h</a>&gt;</code></p>
  79. <table class="memberdecls">
  80. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  81. Data Fields</h2></td></tr>
  82. <tr class="memitem:ad37a97abc68d0af967cef874f4d8df32"><td class="memItemLeft" align="right" valign="top">lws_filefd_type(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlws__plat__file__ops.html#ad37a97abc68d0af967cef874f4d8df32">open</a> )(struct lws *wsi, const char *filename, unsigned long *filelen, int flags)</td></tr>
  83. <tr class="separator:ad37a97abc68d0af967cef874f4d8df32"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:a034ec96f2fbaf52b4aa3e82d20795f7b"><td class="memItemLeft" align="right" valign="top">int(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlws__plat__file__ops.html#a034ec96f2fbaf52b4aa3e82d20795f7b">close</a> )(struct lws *wsi, lws_filefd_type fd)</td></tr>
  85. <tr class="separator:a034ec96f2fbaf52b4aa3e82d20795f7b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <tr class="memitem:abfcda19b003dcc13c61ff9e2bb4ff869"><td class="memItemLeft" align="right" valign="top">unsigned long(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlws__plat__file__ops.html#abfcda19b003dcc13c61ff9e2bb4ff869">seek_cur</a> )(struct lws *wsi, lws_filefd_type fd, long offset_from_cur_pos)</td></tr>
  87. <tr class="separator:abfcda19b003dcc13c61ff9e2bb4ff869"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <tr class="memitem:a01f483807a9862736b17ba9ed5110c40"><td class="memItemLeft" align="right" valign="top">int(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlws__plat__file__ops.html#a01f483807a9862736b17ba9ed5110c40">read</a> )(struct lws *wsi, lws_filefd_type fd, unsigned long *amount, unsigned char *buf, unsigned long len)</td></tr>
  89. <tr class="separator:a01f483807a9862736b17ba9ed5110c40"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:a1fae8330ee94649a3551e31a30809793"><td class="memItemLeft" align="right" valign="top">int(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlws__plat__file__ops.html#a1fae8330ee94649a3551e31a30809793">write</a> )(struct lws *wsi, lws_filefd_type fd, unsigned long *amount, unsigned char *buf, unsigned long len)</td></tr>
  91. <tr class="separator:a1fae8330ee94649a3551e31a30809793"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. </table>
  93. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  94. <div class="textblock"><p>struct <a class="el" href="structlws__plat__file__ops.html">lws_plat_file_ops</a> - Platform-specific file operations</p>
  95. <p>These provide platform-agnostic ways to deal with filesystem access in the library and in the user code. </p>
  96. </div><h2 class="groupheader">Field Documentation</h2>
  97. <a class="anchor" id="a034ec96f2fbaf52b4aa3e82d20795f7b"></a>
  98. <div class="memitem">
  99. <div class="memproto">
  100. <table class="memname">
  101. <tr>
  102. <td class="memname">int(* lws_plat_file_ops::close) (struct lws *wsi, lws_filefd_type fd)</td>
  103. </tr>
  104. </table>
  105. </div><div class="memdoc">
  106. <p>close file </p>
  107. </div>
  108. </div>
  109. <a class="anchor" id="ad37a97abc68d0af967cef874f4d8df32"></a>
  110. <div class="memitem">
  111. <div class="memproto">
  112. <table class="memname">
  113. <tr>
  114. <td class="memname">lws_filefd_type(* lws_plat_file_ops::open) (struct lws *wsi, const char *filename, unsigned long *filelen, int flags)</td>
  115. </tr>
  116. </table>
  117. </div><div class="memdoc">
  118. <p>Open file (always binary access if plat supports it) filelen is filled on exit to be the length of the file flags should be set to O_RDONLY or O_RDWR </p>
  119. </div>
  120. </div>
  121. <a class="anchor" id="a01f483807a9862736b17ba9ed5110c40"></a>
  122. <div class="memitem">
  123. <div class="memproto">
  124. <table class="memname">
  125. <tr>
  126. <td class="memname">int(* lws_plat_file_ops::read) (struct lws *wsi, lws_filefd_type fd, unsigned long *amount, unsigned char *buf, unsigned long len)</td>
  127. </tr>
  128. </table>
  129. </div><div class="memdoc">
  130. <p>Read from file, on exit *amount is set to amount actually read </p>
  131. </div>
  132. </div>
  133. <a class="anchor" id="abfcda19b003dcc13c61ff9e2bb4ff869"></a>
  134. <div class="memitem">
  135. <div class="memproto">
  136. <table class="memname">
  137. <tr>
  138. <td class="memname">unsigned long(* lws_plat_file_ops::seek_cur) (struct lws *wsi, lws_filefd_type fd, long offset_from_cur_pos)</td>
  139. </tr>
  140. </table>
  141. </div><div class="memdoc">
  142. <p>seek from current position </p>
  143. </div>
  144. </div>
  145. <a class="anchor" id="a1fae8330ee94649a3551e31a30809793"></a>
  146. <div class="memitem">
  147. <div class="memproto">
  148. <table class="memname">
  149. <tr>
  150. <td class="memname">int(* lws_plat_file_ops::write) (struct lws *wsi, lws_filefd_type fd, unsigned long *amount, unsigned char *buf, unsigned long len)</td>
  151. </tr>
  152. </table>
  153. </div><div class="memdoc">
  154. <p>Write to file, on exit *amount is set to amount actually written </p>
  155. </div>
  156. </div>
  157. <hr/>The documentation for this struct was generated from the following file:<ul>
  158. <li>lib/<a class="el" href="libwebsockets_8h_source.html">libwebsockets.h</a></li>
  159. </ul>
  160. </div><!-- contents -->
  161. </div><!-- doc-content -->
  162. <!-- start footer part -->
  163. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  164. <ul>
  165. <li class="navelem"><a class="el" href="structlws__plat__file__ops.html">lws_plat_file_ops</a></li>
  166. <li class="footer">Generated by
  167. <a href="http://www.doxygen.org/index.html">
  168. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
  169. </ul>
  170. </div>
  171. </body>
  172. </html>