Newer
Older
UbixOS / doc / xml / structpbuf__rom.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="structpbuf__rom" kind="struct" language="C++" prot="public">
    <compoundname>pbuf_rom</compoundname>
    <includes refid="pbuf_8h" local="no">pbuf.h</includes>
      <sectiondef kind="public-attrib">
      <memberdef kind="variable" id="structpbuf__rom_1a5ffdf590ed65b217e2d96f648e1bd3e7" prot="public" static="no" mutable="no">
        <type>struct <ref refid="structpbuf" kindref="compound">pbuf</ref> *</type>
        <definition>struct pbuf* pbuf_rom::next</definition>
        <argsstring></argsstring>
        <name>next</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>next pbuf in singly linked pbuf chain </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/pbuf.h" line="182" column="13" bodyfile="C:/Dev/git/UbixOS/sys/include/net/pbuf.h" bodystart="182" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="structpbuf__rom_1a5cd0dcc590038629644ad775d76230a1" prot="public" static="no" mutable="no">
        <type><ref refid="cdefs_8h_1a2c212835823e3c54a8ab6d95c652660e" kindref="member">const</ref> void *</type>
        <definition>const void* pbuf_rom::payload</definition>
        <argsstring></argsstring>
        <name>payload</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>pointer to the actual data in the buffer </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/pbuf.h" line="185" column="14" bodyfile="C:/Dev/git/UbixOS/sys/include/net/pbuf.h" bodystart="185" bodyend="-1"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
    </briefdescription>
    <detaileddescription>
<para>Helper struct for const-correctness only. The only meaning of this one is to provide a const payload pointer for PBUF_ROM type. </para>
    </detaileddescription>
    <collaborationgraph>
      <node id="1">
        <label>pbuf_rom</label>
        <link refid="structpbuf__rom"/>
        <childnode refid="2" relation="usage">
          <edgelabel>+next</edgelabel>
        </childnode>
      </node>
      <node id="2">
        <label>pbuf</label>
        <link refid="structpbuf"/>
        <childnode refid="2" relation="usage">
          <edgelabel>+next</edgelabel>
        </childnode>
      </node>
    </collaborationgraph>
    <location file="C:/Dev/git/UbixOS/sys/include/net/pbuf.h" line="180" column="15" bodyfile="C:/Dev/git/UbixOS/sys/include/net/pbuf.h" bodystart="180" bodyend="186"/>
    <listofallmembers>
      <member refid="structpbuf__rom_1a5ffdf590ed65b217e2d96f648e1bd3e7" prot="public" virt="non-virtual"><scope>pbuf_rom</scope><name>next</name></member>
      <member refid="structpbuf__rom_1a5cd0dcc590038629644ad775d76230a1" prot="public" virt="non-virtual"><scope>pbuf_rom</scope><name>payload</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>