Fork: 0
ohpnjrpnicow / UbixOS
Transfer to URL with SHA Find file
Newer
Older
UbixOS / doc / html / d2 / d81 / structtftp__context.html
@Christopher W. Olsen Christopher W. Olsen on 30 Jan 2020 11 KB Cleaning up and adding documentation.
Raw Blame History 
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.16"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>UbixOS: tftp_context 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">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  $(document).ready(initResizable);
/* @license-end */</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="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">UbixOS
   &#160;<span id="projectnumber">2.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('../../',false,false,'search.php','Search');
});
/* @license-end */</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">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('d2/d81/structtftp__context.html','../../');});
/* @license-end */
</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">tftp_context Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="../../d3/d5b/tftp__server_8h_source.html">tftp_server.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for tftp_context:</div>
<div class="dyncontent">
<div class="center"><img src="../../de/d63/structtftp__context__coll__graph.png" border="0" usemap="#tftp__context_coll__map" alt="Collaboration graph"/></div>
<map name="tftp__context_coll__map" id="tftp__context_coll__map">
<area shape="rect" title=" " alt="" coords="5,5,96,127"/>
</map>
</div>
<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:ae9181c57d1cf89bc263f7671e5630a65"><td class="memItemLeft" align="right" valign="top">void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d81/structtftp__context.html#ae9181c57d1cf89bc263f7671e5630a65">close</a> )(void *handle)</td></tr>
<tr class="separator:ae9181c57d1cf89bc263f7671e5630a65"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae70d64e8e20328cc492d766506df4cba"><td class="memItemLeft" align="right" valign="top">void *(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d81/structtftp__context.html#ae70d64e8e20328cc492d766506df4cba">open</a> )(<a class="el" href="../../d6/d92/cdefs_8h.html#a2c212835823e3c54a8ab6d95c652660e">const</a> char *fname, <a class="el" href="../../d6/d92/cdefs_8h.html#a2c212835823e3c54a8ab6d95c652660e">const</a> char *mode, <a class="el" href="../../de/d8c/group__compiler__abstraction.html#ga4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> <a class="el" href="../../d2/d81/structtftp__context.html#a9e6e4ec803ec9597822923369701754d">write</a>)</td></tr>
<tr class="separator:ae70d64e8e20328cc492d766506df4cba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a748e37df0c8b84b3adda78d603b9033c"><td class="memItemLeft" align="right" valign="top">int(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d81/structtftp__context.html#a748e37df0c8b84b3adda78d603b9033c">read</a> )(void *handle, void *<a class="el" href="../../d9/dd0/structbuf.html">buf</a>, int bytes)</td></tr>
<tr class="separator:a748e37df0c8b84b3adda78d603b9033c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9e6e4ec803ec9597822923369701754d"><td class="memItemLeft" align="right" valign="top">int(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d81/structtftp__context.html#a9e6e4ec803ec9597822923369701754d">write</a> )(void *handle, struct <a class="el" href="../../d9/db8/structpbuf.html">pbuf</a> *p)</td></tr>
<tr class="separator:a9e6e4ec803ec9597822923369701754d"><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>TFTP context containing callback functions for TFTP transfers </p>

<p class="definition">Definition at line <a class="el" href="../../d3/d5b/tftp__server_8h_source.html#l00055">55</a> of file <a class="el" href="../../d3/d5b/tftp__server_8h_source.html">tftp_server.h</a>.</p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="ae9181c57d1cf89bc263f7671e5630a65"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae9181c57d1cf89bc263f7671e5630a65">&#9670;&nbsp;</a></span>close</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void(* tftp_context::close) (void *handle)</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Close file handle </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">handle</td><td>File handle returned by <a class="el" href="../../d2/d81/structtftp__context.html#ae70d64e8e20328cc492d766506df4cba">open()</a> </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="../../d3/d5b/tftp__server_8h_source.html#l00068">68</a> of file <a class="el" href="../../d3/d5b/tftp__server_8h_source.html">tftp_server.h</a>.</p>

</div>
</div>
<a id="ae70d64e8e20328cc492d766506df4cba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae70d64e8e20328cc492d766506df4cba">&#9670;&nbsp;</a></span>open</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void*(* tftp_context::open) (<a class="el" href="../../d6/d92/cdefs_8h.html#a2c212835823e3c54a8ab6d95c652660e">const</a> char *fname, <a class="el" href="../../d6/d92/cdefs_8h.html#a2c212835823e3c54a8ab6d95c652660e">const</a> char *mode, <a class="el" href="../../de/d8c/group__compiler__abstraction.html#ga4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> <a class="el" href="../../d2/d81/structtftp__context.html#a9e6e4ec803ec9597822923369701754d">write</a>)</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Open file for read/write. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">fname</td><td>Filename </td></tr>
    <tr><td class="paramname">mode</td><td>Mode string from TFTP RFC 1350 (netascii, octet, mail) </td></tr>
    <tr><td class="paramname">write</td><td>Flag indicating read (0) or write (!= 0) access </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>File handle supplied to other functions </dd></dl>

<p class="definition">Definition at line <a class="el" href="../../d3/d5b/tftp__server_8h_source.html#l00063">63</a> of file <a class="el" href="../../d3/d5b/tftp__server_8h_source.html">tftp_server.h</a>.</p>

</div>
</div>
<a id="a748e37df0c8b84b3adda78d603b9033c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a748e37df0c8b84b3adda78d603b9033c">&#9670;&nbsp;</a></span>read</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int(* tftp_context::read) (void *handle, void *<a class="el" href="../../d9/dd0/structbuf.html">buf</a>, int bytes)</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Read from file </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">handle</td><td>File handle returned by <a class="el" href="../../d2/d81/structtftp__context.html#ae70d64e8e20328cc492d766506df4cba">open()</a> </td></tr>
    <tr><td class="paramname">buf</td><td>Target buffer to copy read data to </td></tr>
    <tr><td class="paramname">bytes</td><td>Number of bytes to copy to buf </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>&gt;= 0: Success; &lt; 0: Error </dd></dl>

<p class="definition">Definition at line <a class="el" href="../../d3/d5b/tftp__server_8h_source.html#l00076">76</a> of file <a class="el" href="../../d3/d5b/tftp__server_8h_source.html">tftp_server.h</a>.</p>

</div>
</div>
<a id="a9e6e4ec803ec9597822923369701754d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9e6e4ec803ec9597822923369701754d">&#9670;&nbsp;</a></span>write</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int(* tftp_context::write) (void *handle, struct <a class="el" href="../../d9/db8/structpbuf.html">pbuf</a> *p)</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Write to file </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">handle</td><td>File handle returned by <a class="el" href="../../d2/d81/structtftp__context.html#ae70d64e8e20328cc492d766506df4cba">open()</a> </td></tr>
    <tr><td class="paramname">pbuf</td><td>PBUF adjusted such that payload pointer points to the beginning of write data. In other words, TFTP headers are stripped off. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>&gt;= 0: Success; &lt; 0: Error </dd></dl>

<p class="definition">Definition at line <a class="el" href="../../d3/d5b/tftp__server_8h_source.html#l00085">85</a> of file <a class="el" href="../../d3/d5b/tftp__server_8h_source.html">tftp_server.h</a>.</p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>include/net/apps/<a class="el" href="../../d3/d5b/tftp__server_8h_source.html">tftp_server.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="../../d2/d81/structtftp__context.html">tftp_context</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.16 </li>
  </ul>
</div>
</body>
</html>