mirror of
https://github.com/warmcat/libwebsockets.git
synced 2025-03-16 00:00:07 +01:00
174 lines
8.6 KiB
HTML
174 lines
8.6 KiB
HTML
<!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.12"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>libwebsockets: lws_plat_file_ops Struct 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="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(initResizable);
|
|
</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 id="projectlogo"><img alt="Logo" src="libwebsockets.org-logo.png"/></td>
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">libwebsockets
|
|
</div>
|
|
<div id="projectbrief">Lightweight C library for HTML5 websockets</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.12 -->
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
$(function() {
|
|
initMenu('',false,false,'search.php','Search');
|
|
});
|
|
</script>
|
|
<div id="main-nav"></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('structlws__plat__file__ops.html','');});
|
|
</script>
|
|
<div id="doc-content">
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-attribs">Data Fields</a> </div>
|
|
<div class="headertitle">
|
|
<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>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
|
|
Data Fields</h2></td></tr>
|
|
<tr class="memitem:a79484f37c8e54d75342eb2ecf97b5f7b"><td class="memItemLeft" align="right" valign="top">lws_filefd_type(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structlws__plat__file__ops.html#a79484f37c8e54d75342eb2ecf97b5f7b">LWS_FOP_OPEN</a> )(struct lws *wsi, const char *filename, unsigned long *filelen, int *flags)</td></tr>
|
|
<tr class="separator:a79484f37c8e54d75342eb2ecf97b5f7b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaa412792d1e8df151729850a6448f001"><td class="memItemLeft" align="right" valign="top">int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structlws__plat__file__ops.html#aaa412792d1e8df151729850a6448f001">LWS_FOP_CLOSE</a> )(struct lws *wsi, lws_filefd_type fd)</td></tr>
|
|
<tr class="separator:aaa412792d1e8df151729850a6448f001"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1352a356778159c97195a5bff65dda6c"><td class="memItemLeft" align="right" valign="top">unsigned long(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structlws__plat__file__ops.html#a1352a356778159c97195a5bff65dda6c">LWS_FOP_SEEK_CUR</a> )(struct lws *wsi, lws_filefd_type fd, long offset_from_cur_pos)</td></tr>
|
|
<tr class="separator:a1352a356778159c97195a5bff65dda6c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4ddeac2cd3d3bdf517ad355dbc123d00"><td class="memItemLeft" align="right" valign="top">int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structlws__plat__file__ops.html#a4ddeac2cd3d3bdf517ad355dbc123d00">LWS_FOP_READ</a> )(struct lws *wsi, lws_filefd_type fd, unsigned long *amount, unsigned char *buf, unsigned long len)</td></tr>
|
|
<tr class="separator:a4ddeac2cd3d3bdf517ad355dbc123d00"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5e801362a7d11b83608980123233a220"><td class="memItemLeft" align="right" valign="top">int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structlws__plat__file__ops.html#a5e801362a7d11b83608980123233a220">LWS_FOP_WRITE</a> )(struct lws *wsi, lws_filefd_type fd, unsigned long *amount, unsigned char *buf, unsigned long len)</td></tr>
|
|
<tr class="separator:a5e801362a7d11b83608980123233a220"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Field Documentation</h2>
|
|
<a id="aaa412792d1e8df151729850a6448f001"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aaa412792d1e8df151729850a6448f001">§ </a></span>LWS_FOP_CLOSE</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int(* lws_plat_file_ops::LWS_FOP_CLOSE) (struct lws *wsi, lws_filefd_type fd)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>close file </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a79484f37c8e54d75342eb2ecf97b5f7b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a79484f37c8e54d75342eb2ecf97b5f7b">§ </a></span>LWS_FOP_OPEN</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">lws_filefd_type(* lws_plat_file_ops::LWS_FOP_OPEN) (struct lws *wsi, const char *filename, unsigned long *filelen, int *flags)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Open file (always binary access if plat supports it) filelen is filled on exit to be the length of the file *flags & LWS_FOP_FLAGS_MASK should be set to O_RDONLY or O_RDWR. If the file may be gzip-compressed, LWS_FOP_FLAG_COMPR_ACCEPTABLE_GZIP is set. If it actually is gzip-compressed, then the open handler should OR LWS_FOP_FLAG_COMPR_IS_GZIP on to *flags before returning. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4ddeac2cd3d3bdf517ad355dbc123d00"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4ddeac2cd3d3bdf517ad355dbc123d00">§ </a></span>LWS_FOP_READ</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int(* lws_plat_file_ops::LWS_FOP_READ) (struct lws *wsi, lws_filefd_type fd, unsigned long *amount, unsigned char *buf, unsigned long len)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Read from file, on exit *amount is set to amount actually read </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1352a356778159c97195a5bff65dda6c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1352a356778159c97195a5bff65dda6c">§ </a></span>LWS_FOP_SEEK_CUR</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">unsigned long(* lws_plat_file_ops::LWS_FOP_SEEK_CUR) (struct lws *wsi, lws_filefd_type fd, long offset_from_cur_pos)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>seek from current position </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5e801362a7d11b83608980123233a220"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5e801362a7d11b83608980123233a220">§ </a></span>LWS_FOP_WRITE</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int(* lws_plat_file_ops::LWS_FOP_WRITE) (struct lws *wsi, lws_filefd_type fd, unsigned long *amount, unsigned char *buf, unsigned long len)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Write to file, on exit *amount is set to amount actually written </p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this struct was generated from the following file:<ul>
|
|
<li>lib/<a class="el" href="libwebsockets_8h_source.html">libwebsockets.h</a></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="structlws__plat__file__ops.html">lws_plat_file_ops</a></li>
|
|
<li class="footer">Generated by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.12 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|