Newer
Older
UbixOS / doc / xml / tftp__opts_8h.xml
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.8.16">
  <compounddef id="tftp__opts_8h" kind="file" language="C++">
    <compoundname>tftp_opts.h</compoundname>
    <includes local="yes">lwip/opt.h</includes>
    <incdepgraph>
      <node id="1">
        <label>C:/Dev/git/UbixOS/sys/include/net/apps/tftp_opts.h</label>
        <link refid="tftp__opts_8h"/>
        <childnode refid="2" relation="include">
        </childnode>
      </node>
      <node id="2">
        <label>lwip/opt.h</label>
      </node>
    </incdepgraph>
      <sectiondef kind="define">
      <memberdef kind="define" id="group__tftp__opts_1ga2dd54a1d0c3006527b8a7a8604b81981" prot="public" static="no">
        <name>TFTP_DEBUG</name>
        <initializer><ref refid="group__debugging__levels_1ga9e31b7cbbc8f46af8e62b548079acd4e" kindref="member">LWIP_DBG_ON</ref></initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>Enable TFTP debug messages </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/apps/tftp_opts.h" line="56" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/apps/tftp_opts.h" bodystart="56" bodyend="-1"/>
      </memberdef>
      <memberdef kind="define" id="group__tftp__opts_1ga8e975900b4397313f1a649ff76a3063b" prot="public" static="no">
        <name>TFTP_MAX_FILENAME_LEN</name>
        <initializer>20</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>Max. length of TFTP filename </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/apps/tftp_opts.h" line="91" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/apps/tftp_opts.h" bodystart="91" bodyend="-1"/>
      </memberdef>
      <memberdef kind="define" id="group__tftp__opts_1gaa8a449c25e37be757f5efccd422c9055" prot="public" static="no">
        <name>TFTP_MAX_MODE_LEN</name>
        <initializer>7</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>Max. length of TFTP mode </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/apps/tftp_opts.h" line="98" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/apps/tftp_opts.h" bodystart="98" bodyend="-1"/>
      </memberdef>
      <memberdef kind="define" id="group__tftp__opts_1ga6a01757ad942eb602e8a87e2be42d313" prot="public" static="no">
        <name>TFTP_MAX_RETRIES</name>
        <initializer>5</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>Max. number of retries when a file is read from server </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/apps/tftp_opts.h" line="77" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/apps/tftp_opts.h" bodystart="77" bodyend="-1"/>
      </memberdef>
      <memberdef kind="define" id="group__tftp__opts_1gad9230620a5d3bb87a7ac280ff99875d1" prot="public" static="no">
        <name>TFTP_PORT</name>
        <initializer>69</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>TFTP server port </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/apps/tftp_opts.h" line="63" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/apps/tftp_opts.h" bodystart="63" bodyend="-1"/>
      </memberdef>
      <memberdef kind="define" id="group__tftp__opts_1ga36986e5465dc2ccb6184fc57f9a37d63" prot="public" static="no">
        <name>TFTP_TIMEOUT_MSECS</name>
        <initializer>10000</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>TFTP timeout </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/apps/tftp_opts.h" line="70" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/apps/tftp_opts.h" bodystart="70" bodyend="-1"/>
      </memberdef>
      <memberdef kind="define" id="group__tftp__opts_1ga3e6caacb3f4d43f780b2d68ffe4258ea" prot="public" static="no">
        <name>TFTP_TIMER_MSECS</name>
        <initializer>50</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>TFTP timer cyclic interval </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/apps/tftp_opts.h" line="84" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/apps/tftp_opts.h" bodystart="84" bodyend="-1"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Trivial File Transfer Protocol (RFC 1350) implementation options. </para>
    </briefdescription>
    <detaileddescription>
<para><simplesect kind="author"><para>Logan Gunthorpe <ulink url="mailto:logang@deltatee.com">logang@deltatee.com</ulink></para>
</simplesect>
Copyright (c) Deltatee Enterprises Ltd. 2013 All rights reserved. </para>
    </detaileddescription>
    <programlisting>
<codeline lineno="1"><highlight class="comment">/****************************************************************/</highlight></codeline>
<codeline lineno="14"><highlight class="comment">/*<sp/></highlight></codeline>
<codeline lineno="15"><highlight class="comment"><sp/>*<sp/>Redistribution<sp/>and<sp/>use<sp/>in<sp/>source<sp/>and<sp/>binary<sp/>forms,<sp/>with<sp/>or<sp/>without</highlight></codeline>
<codeline lineno="16"><highlight class="comment"><sp/>*<sp/>modification,are<sp/>permitted<sp/>provided<sp/>that<sp/>the<sp/>following<sp/>conditions<sp/>are<sp/>met:</highlight></codeline>
<codeline lineno="17"><highlight class="comment"><sp/>*</highlight></codeline>
<codeline lineno="18"><highlight class="comment"><sp/>*<sp/>1.<sp/>Redistributions<sp/>of<sp/>source<sp/>code<sp/>must<sp/>retain<sp/>the<sp/>above<sp/>copyright<sp/>notice,</highlight></codeline>
<codeline lineno="19"><highlight class="comment"><sp/>*<sp/><sp/><sp/><sp/>this<sp/>list<sp/>of<sp/>conditions<sp/>and<sp/>the<sp/>following<sp/>disclaimer.</highlight></codeline>
<codeline lineno="20"><highlight class="comment"><sp/>*<sp/>2.<sp/>Redistributions<sp/>in<sp/>binary<sp/>form<sp/>must<sp/>reproduce<sp/>the<sp/>above<sp/>copyright<sp/>notice,</highlight></codeline>
<codeline lineno="21"><highlight class="comment"><sp/>*<sp/><sp/><sp/><sp/>this<sp/>list<sp/>of<sp/>conditions<sp/>and<sp/>the<sp/>following<sp/>disclaimer<sp/>in<sp/>the<sp/>documentation</highlight></codeline>
<codeline lineno="22"><highlight class="comment"><sp/>*<sp/><sp/><sp/><sp/>and/or<sp/>other<sp/>materials<sp/>provided<sp/>with<sp/>the<sp/>distribution.</highlight></codeline>
<codeline lineno="23"><highlight class="comment"><sp/>*<sp/>3.<sp/>The<sp/>name<sp/>of<sp/>the<sp/>author<sp/>may<sp/>not<sp/>be<sp/>used<sp/>to<sp/>endorse<sp/>or<sp/>promote<sp/>products</highlight></codeline>
<codeline lineno="24"><highlight class="comment"><sp/>*<sp/><sp/><sp/><sp/>derived<sp/>from<sp/>this<sp/>software<sp/>without<sp/>specific<sp/>prior<sp/>written<sp/>permission.</highlight></codeline>
<codeline lineno="25"><highlight class="comment"><sp/>*</highlight></codeline>
<codeline lineno="26"><highlight class="comment"><sp/>*<sp/>THIS<sp/>SOFTWARE<sp/>IS<sp/>PROVIDED<sp/>BY<sp/>THE<sp/>AUTHOR<sp/>``AS<sp/>IS&apos;&apos;<sp/>AND<sp/>ANY<sp/>EXPRESS<sp/>OR<sp/>IMPLIED</highlight></codeline>
<codeline lineno="27"><highlight class="comment"><sp/>*<sp/>WARRANTIES,<sp/>INCLUDING,<sp/>BUT<sp/>NOT<sp/>LIMITED<sp/>TO,<sp/>THE<sp/>IMPLIED<sp/>WARRANTIES<sp/>OF</highlight></codeline>
<codeline lineno="28"><highlight class="comment"><sp/>*<sp/>MERCHANTABILITY<sp/>AND<sp/>FITNESS<sp/>FOR<sp/>A<sp/>PARTICULAR<sp/>PURPOSE<sp/>ARE<sp/>DISCLAIMED.<sp/>IN<sp/>NO</highlight></codeline>
<codeline lineno="29"><highlight class="comment"><sp/>*<sp/>EVENT<sp/>SHALL<sp/>THE<sp/>AUTHOR<sp/>BE<sp/>LIABLE<sp/>FOR<sp/>ANY<sp/>DIRECT,<sp/>INDIRECT,<sp/>INCIDENTAL,</highlight></codeline>
<codeline lineno="30"><highlight class="comment"><sp/>*<sp/>SPECIAL,<sp/>EXEMPLARY,<sp/>OR<sp/>CONSEQUENTIAL<sp/>DAMAGES<sp/>(INCLUDING,<sp/>BUT<sp/>NOT<sp/>LIMITED</highlight></codeline>
<codeline lineno="31"><highlight class="comment"><sp/>*<sp/>TO,<sp/>PROCUREMENT<sp/>OF<sp/>SUBSTITUTE<sp/>GOODS<sp/>OR<sp/>SERVICES;<sp/>LOSS<sp/>OF<sp/>USE,<sp/>DATA,<sp/>OR</highlight></codeline>
<codeline lineno="32"><highlight class="comment"><sp/>*<sp/>PROFITS;<sp/>OR<sp/>BUSINESS<sp/>INTERRUPTION)<sp/>HOWEVER<sp/>CAUSED<sp/>AND<sp/>ON<sp/>ANY<sp/>THEORY<sp/>OF</highlight></codeline>
<codeline lineno="33"><highlight class="comment"><sp/>*<sp/>LIABILITY,<sp/>WHETHER<sp/>IN<sp/>CONTRACT,<sp/>STRICT<sp/>LIABILITY,<sp/>OR<sp/>TORT<sp/>(INCLUDING</highlight></codeline>
<codeline lineno="34"><highlight class="comment"><sp/>*<sp/>NEGLIGENCE<sp/>OR<sp/>OTHERWISE)<sp/>ARISING<sp/>IN<sp/>ANY<sp/>WAY<sp/>OUT<sp/>OF<sp/>THE<sp/>USE<sp/>OF<sp/>THIS</highlight></codeline>
<codeline lineno="35"><highlight class="comment"><sp/>*<sp/>SOFTWARE,<sp/>EVEN<sp/>IF<sp/>ADVISED<sp/>OF<sp/>THE<sp/>POSSIBILITY<sp/>OF<sp/>SUCH<sp/>DAMAGE.</highlight></codeline>
<codeline lineno="36"><highlight class="comment"><sp/>*</highlight></codeline>
<codeline lineno="37"><highlight class="comment"><sp/>*<sp/>Author:<sp/>Logan<sp/>Gunthorpe<sp/>&lt;logang@deltatee.com&gt;</highlight></codeline>
<codeline lineno="38"><highlight class="comment"><sp/>*</highlight></codeline>
<codeline lineno="39"><highlight class="comment"><sp/>*/</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="40"><highlight class="normal"></highlight></codeline>
<codeline lineno="41"><highlight class="normal"></highlight><highlight class="preprocessor">#ifndef<sp/>LWIP_HDR_APPS_TFTP_OPTS_H</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="42"><highlight class="normal"></highlight><highlight class="preprocessor">#define<sp/>LWIP_HDR_APPS_TFTP_OPTS_H</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="43"><highlight class="normal"></highlight></codeline>
<codeline lineno="44"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&quot;lwip/opt.h&quot;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="45"><highlight class="normal"></highlight></codeline>
<codeline lineno="55"><highlight class="preprocessor">#if<sp/>!defined<sp/>TFTP_DEBUG<sp/>||<sp/>defined<sp/>__DOXYGEN__</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="56" refid="group__tftp__opts_1ga2dd54a1d0c3006527b8a7a8604b81981" refkind="member"><highlight class="normal"></highlight><highlight class="preprocessor">#define<sp/>TFTP_DEBUG<sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>LWIP_DBG_ON</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="57"><highlight class="normal"></highlight><highlight class="preprocessor">#endif</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="58"><highlight class="normal"></highlight></codeline>
<codeline lineno="62"><highlight class="preprocessor">#if<sp/>!defined<sp/>TFTP_PORT<sp/>||<sp/>defined<sp/>__DOXYGEN__</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="63" refid="group__tftp__opts_1gad9230620a5d3bb87a7ac280ff99875d1" refkind="member"><highlight class="normal"></highlight><highlight class="preprocessor">#define<sp/>TFTP_PORT<sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>69</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="64"><highlight class="normal"></highlight><highlight class="preprocessor">#endif</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="65"><highlight class="normal"></highlight></codeline>
<codeline lineno="69"><highlight class="preprocessor">#if<sp/>!defined<sp/>TFTP_TIMEOUT_MSECS<sp/>||<sp/>defined<sp/>__DOXYGEN__</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="70" refid="group__tftp__opts_1ga36986e5465dc2ccb6184fc57f9a37d63" refkind="member"><highlight class="normal"></highlight><highlight class="preprocessor">#define<sp/>TFTP_TIMEOUT_MSECS<sp/><sp/><sp/><sp/>10000</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="71"><highlight class="normal"></highlight><highlight class="preprocessor">#endif</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="72"><highlight class="normal"></highlight></codeline>
<codeline lineno="76"><highlight class="preprocessor">#if<sp/>!defined<sp/>TFTP_MAX_RETRIES<sp/>||<sp/>defined<sp/>__DOXYGEN__</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="77" refid="group__tftp__opts_1ga6a01757ad942eb602e8a87e2be42d313" refkind="member"><highlight class="normal"></highlight><highlight class="preprocessor">#define<sp/>TFTP_MAX_RETRIES<sp/><sp/><sp/><sp/><sp/><sp/>5</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="78"><highlight class="normal"></highlight><highlight class="preprocessor">#endif</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="79"><highlight class="normal"></highlight></codeline>
<codeline lineno="83"><highlight class="preprocessor">#if<sp/>!defined<sp/>TFTP_TIMER_MSECS<sp/>||<sp/>defined<sp/>__DOXYGEN__</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="84" refid="group__tftp__opts_1ga3e6caacb3f4d43f780b2d68ffe4258ea" refkind="member"><highlight class="normal"></highlight><highlight class="preprocessor">#define<sp/>TFTP_TIMER_MSECS<sp/><sp/><sp/><sp/><sp/><sp/>50</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="85"><highlight class="normal"></highlight><highlight class="preprocessor">#endif</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="86"><highlight class="normal"></highlight></codeline>
<codeline lineno="90"><highlight class="preprocessor">#if<sp/>!defined<sp/>TFTP_MAX_FILENAME_LEN<sp/>||<sp/>defined<sp/>__DOXYGEN__</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="91" refid="group__tftp__opts_1ga8e975900b4397313f1a649ff76a3063b" refkind="member"><highlight class="normal"></highlight><highlight class="preprocessor">#define<sp/>TFTP_MAX_FILENAME_LEN<sp/>20</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="92"><highlight class="normal"></highlight><highlight class="preprocessor">#endif</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="93"><highlight class="normal"></highlight></codeline>
<codeline lineno="97"><highlight class="preprocessor">#if<sp/>!defined<sp/>TFTP_MAX_MODE_LEN<sp/>||<sp/>defined<sp/>__DOXYGEN__</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="98" refid="group__tftp__opts_1gaa8a449c25e37be757f5efccd422c9055" refkind="member"><highlight class="normal"></highlight><highlight class="preprocessor">#define<sp/>TFTP_MAX_MODE_LEN<sp/><sp/><sp/><sp/><sp/>7</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="99"><highlight class="normal"></highlight><highlight class="preprocessor">#endif</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="100"><highlight class="normal"></highlight></codeline>
<codeline lineno="105"><highlight class="preprocessor">#endif<sp/></highlight><highlight class="comment">/*<sp/>LWIP_HDR_APPS_TFTP_OPTS_H<sp/>*/</highlight><highlight class="preprocessor"></highlight></codeline>
    </programlisting>
    <location file="C:/Dev/git/UbixOS/sys/include/net/apps/tftp_opts.h"/>
  </compounddef>
</doxygen>