Newer
Older
UbixOS / doc / xml / structpbuf.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" kind="struct" language="C++" prot="public">
    <compoundname>pbuf</compoundname>
    <includes refid="pbuf_8h" local="no">pbuf.h</includes>
      <sectiondef kind="public-attrib">
      <memberdef kind="variable" id="structpbuf_1aa4d1af2cab3d9280d29212095b5b872a" prot="public" static="no" mutable="no">
        <type><ref refid="group__compiler__abstraction_1ga4caecabca98b43919dd11be1c0d4cd8e" kindref="member">u8_t</ref></type>
        <definition>u8_t pbuf::flags</definition>
        <argsstring></argsstring>
        <name>flags</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>misc flags </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/pbuf.h" line="165" column="8" bodyfile="C:/Dev/git/UbixOS/sys/include/net/pbuf.h" bodystart="165" bodyend="-1"/>
        <referencedby refid="group__pbuf_1gacfcb0a2af918658ba0afe36499c65f47" compoundref="pbuf_8c" startline="248" endline="405">pbuf_alloc</referencedby>
        <referencedby refid="group__pbuf_1ga50abfe830a33a1a47a562febee66015d" compoundref="pbuf_8c" startline="493" endline="555">pbuf_realloc</referencedby>
      </memberdef>
      <memberdef kind="variable" id="structpbuf_1a6f82449625e36e294f5d210268c0703f" prot="public" static="no" mutable="no">
        <type><ref refid="group__compiler__abstraction_1ga77570ac4fcab86864fa1916e55676da2" kindref="member">u16_t</ref></type>
        <definition>u16_t pbuf::len</definition>
        <argsstring></argsstring>
        <name>len</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>length of this buffer </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/pbuf.h" line="159" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/pbuf.h" bodystart="159" bodyend="-1"/>
        <referencedby refid="inet__chksum_8c_1a34f1aa1587562a09e11b704b51bab043" compoundref="inet__chksum_8c" startline="555" endline="558">inet_chksum</referencedby>
        <referencedby refid="inet__chksum_8c_1ab35967a50418358e194e8f80fdc3c865" compoundref="inet__chksum_8c" startline="568" endline="589">inet_chksum_pbuf</referencedby>
        <referencedby refid="group__sys__nonstandard_1ga997dcc49451121d4ed755b33bc7bd26a" compoundref="def_8c" startline="161" endline="186">lwip_strnicmp</referencedby>
        <referencedby refid="group__pbuf_1gacfcb0a2af918658ba0afe36499c65f47" compoundref="pbuf_8c" startline="248" endline="405">pbuf_alloc</referencedby>
        <referencedby refid="group__pbuf_1ga82429084fe29015509c9b4a072707cd4" compoundref="pbuf_8c" startline="841" endline="863">pbuf_cat</referencedby>
        <referencedby refid="group__pbuf_1gaba88511dee3df4b631fde691f421320d" compoundref="pbuf_8c" startline="949" endline="1001">pbuf_copy</referencedby>
        <referencedby refid="group__pbuf_1gac2f1f58fd36042e82af46f5015720899" compoundref="pbuf_8c" startline="1016" endline="1052">pbuf_copy_partial</referencedby>
        <referencedby refid="pbuf_8c_1abf3d29c4f43986b4cb5eb314d5b9729d" compoundref="pbuf_8c" startline="900" endline="928">pbuf_dechain</referencedby>
        <referencedby refid="group__pbuf_1ga2170ccbbb13238380dbb203ee1b85974" compoundref="pbuf_8c" startline="1363" endline="1390">pbuf_memcmp</referencedby>
        <referencedby refid="group__pbuf_1gaf76863707dc02993eae116574b1ea03f" compoundref="pbuf_8c" startline="1340" endline="1349">pbuf_put_at</referencedby>
        <referencedby refid="group__pbuf_1ga50abfe830a33a1a47a562febee66015d" compoundref="pbuf_8c" startline="493" endline="555">pbuf_realloc</referencedby>
        <referencedby refid="group__pbuf_1gad1e31e370271335b197272af2724ca85" compoundref="pbuf_8c" startline="1150" endline="1180">pbuf_take</referencedby>
        <referencedby refid="group__pbuf_1gae1cf2bf7454ff87ff377b0b2262f9b44" compoundref="pbuf_8c" startline="1194" endline="1214">pbuf_take_at</referencedby>
      </memberdef>
      <memberdef kind="variable" id="structpbuf_1a5e5763c94fd18d78937b0b58ce7df341" prot="public" static="no" mutable="no">
        <type>struct <ref refid="structpbuf" kindref="compound">pbuf</ref> *</type>
        <definition>struct pbuf* pbuf::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="144" column="13" bodyfile="C:/Dev/git/UbixOS/sys/include/net/pbuf.h" bodystart="144" bodyend="-1"/>
        <referencedby refid="inet__chksum_8c_1ab35967a50418358e194e8f80fdc3c865" compoundref="inet__chksum_8c" startline="568" endline="589">inet_chksum_pbuf</referencedby>
        <referencedby refid="group__pbuf_1gacfcb0a2af918658ba0afe36499c65f47" compoundref="pbuf_8c" startline="248" endline="405">pbuf_alloc</referencedby>
        <referencedby refid="group__pbuf_1ga82429084fe29015509c9b4a072707cd4" compoundref="pbuf_8c" startline="841" endline="863">pbuf_cat</referencedby>
        <referencedby refid="pbuf_8c_1a5df7ac5ae59012fe9aeddba375a72190" compoundref="pbuf_8c" startline="801" endline="811">pbuf_clen</referencedby>
        <referencedby refid="group__pbuf_1ga54ac7b116c6f53c704cbf74f35a8b35c" compoundref="pbuf_8c" startline="1230" endline="1247">pbuf_coalesce</referencedby>
        <referencedby refid="group__pbuf_1gac2f1f58fd36042e82af46f5015720899" compoundref="pbuf_8c" startline="1016" endline="1052">pbuf_copy_partial</referencedby>
        <referencedby refid="pbuf_8c_1abf3d29c4f43986b4cb5eb314d5b9729d" compoundref="pbuf_8c" startline="900" endline="928">pbuf_dechain</referencedby>
        <referencedby refid="group__pbuf_1gab0dd696fb4b6bc65e548944584f1738b" compoundref="pbuf_8c" startline="715" endline="792">pbuf_free</referencedby>
        <referencedby refid="group__pbuf_1ga2170ccbbb13238380dbb203ee1b85974" compoundref="pbuf_8c" startline="1363" endline="1390">pbuf_memcmp</referencedby>
        <referencedby refid="group__pbuf_1ga50abfe830a33a1a47a562febee66015d" compoundref="pbuf_8c" startline="493" endline="555">pbuf_realloc</referencedby>
        <referencedby refid="group__pbuf_1gad1e31e370271335b197272af2724ca85" compoundref="pbuf_8c" startline="1150" endline="1180">pbuf_take</referencedby>
        <referencedby refid="group__pbuf_1gae1cf2bf7454ff87ff377b0b2262f9b44" compoundref="pbuf_8c" startline="1194" endline="1214">pbuf_take_at</referencedby>
      </memberdef>
      <memberdef kind="variable" id="structpbuf_1a8d32dc3e964369d4eec638fc37fbc460" prot="public" static="no" mutable="no">
        <type>void *</type>
        <definition>void* pbuf::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="147" column="8" bodyfile="C:/Dev/git/UbixOS/sys/include/net/pbuf.h" bodystart="147" bodyend="-1"/>
        <referencedby refid="arp_8c_1a57a25dd51cf73f048ad5364ecc2f040b" compoundref="arp_8c" startline="197" endline="257">arp_arp_input</referencedby>
        <referencedby refid="arp_8c_1a916d08dbb8f4a38e1e904a8a018b000c" compoundref="arp_8c" startline="181" endline="194">arp_ip_input</referencedby>
        <referencedby refid="arp_8c_1a9d1287b9a80c370797b2ac5c63f70e2e" compoundref="arp_8c" startline="273" endline="309">arp_query</referencedby>
        <referencedby refid="inet__chksum_8c_1ab35967a50418358e194e8f80fdc3c865" compoundref="inet__chksum_8c" startline="568" endline="589">inet_chksum_pbuf</referencedby>
        <referencedby refid="group__pbuf_1gacfcb0a2af918658ba0afe36499c65f47" compoundref="pbuf_8c" startline="248" endline="405">pbuf_alloc</referencedby>
        <referencedby refid="group__pbuf_1gac2f1f58fd36042e82af46f5015720899" compoundref="pbuf_8c" startline="1016" endline="1052">pbuf_copy_partial</referencedby>
        <referencedby refid="group__pbuf_1gaf76863707dc02993eae116574b1ea03f" compoundref="pbuf_8c" startline="1340" endline="1349">pbuf_put_at</referencedby>
        <referencedby refid="group__pbuf_1ga50abfe830a33a1a47a562febee66015d" compoundref="pbuf_8c" startline="493" endline="555">pbuf_realloc</referencedby>
        <referencedby refid="group__pbuf_1gad1e31e370271335b197272af2724ca85" compoundref="pbuf_8c" startline="1150" endline="1180">pbuf_take</referencedby>
        <referencedby refid="group__pbuf_1gae1cf2bf7454ff87ff377b0b2262f9b44" compoundref="pbuf_8c" startline="1194" endline="1214">pbuf_take_at</referencedby>
      </memberdef>
      <memberdef kind="variable" id="structpbuf_1a18e2c02942feb1baa3756fcd585b6731" prot="public" static="no" mutable="no">
        <type><ref refid="group__compiler__abstraction_1ga77570ac4fcab86864fa1916e55676da2" kindref="member">u16_t</ref></type>
        <definition>u16_t pbuf::ref</definition>
        <argsstring></argsstring>
        <name>ref</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>the reference count always equals the number of pointers that refer to this pbuf. This can be pointers from an application, the stack itself, or pbuf-&gt;next pointers from a chain. </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/pbuf.h" line="172" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/pbuf.h" bodystart="172" bodyend="-1"/>
        <referencedby refid="group__pbuf_1gacfcb0a2af918658ba0afe36499c65f47" compoundref="pbuf_8c" startline="248" endline="405">pbuf_alloc</referencedby>
        <referencedby refid="group__pbuf_1gab0dd696fb4b6bc65e548944584f1738b" compoundref="pbuf_8c" startline="715" endline="792">pbuf_free</referencedby>
        <referencedby refid="group__pbuf_1ga77f6bbd69e45e542014d9c547c7da74e" compoundref="pbuf_8c" startline="821" endline="828">pbuf_ref</referencedby>
      </memberdef>
      <memberdef kind="variable" id="structpbuf_1a5259e7ec29bab9c0999b64f2e86b411f" prot="public" static="no" mutable="no">
        <type><ref refid="group__compiler__abstraction_1ga77570ac4fcab86864fa1916e55676da2" kindref="member">u16_t</ref></type>
        <definition>u16_t pbuf::tot_len</definition>
        <argsstring></argsstring>
        <name>tot_len</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>total length of this buffer and all next buffers in chain belonging to the same packet.</para>
<para>For non-queue packet chains this is the invariant: p-&gt;tot_len == p-&gt;len + (p-&gt;next? p-&gt;next-&gt;tot_len: 0) </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/pbuf.h" line="156" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/pbuf.h" bodystart="156" bodyend="-1"/>
        <referencedby refid="arp_8c_1a57a25dd51cf73f048ad5364ecc2f040b" compoundref="arp_8c" startline="197" endline="257">arp_arp_input</referencedby>
        <referencedby refid="group__pbuf_1gacfcb0a2af918658ba0afe36499c65f47" compoundref="pbuf_8c" startline="248" endline="405">pbuf_alloc</referencedby>
        <referencedby refid="group__pbuf_1ga82429084fe29015509c9b4a072707cd4" compoundref="pbuf_8c" startline="841" endline="863">pbuf_cat</referencedby>
        <referencedby refid="group__pbuf_1ga54ac7b116c6f53c704cbf74f35a8b35c" compoundref="pbuf_8c" startline="1230" endline="1247">pbuf_coalesce</referencedby>
        <referencedby refid="pbuf_8c_1abf3d29c4f43986b4cb5eb314d5b9729d" compoundref="pbuf_8c" startline="900" endline="928">pbuf_dechain</referencedby>
        <referencedby refid="group__pbuf_1ga2170ccbbb13238380dbb203ee1b85974" compoundref="pbuf_8c" startline="1363" endline="1390">pbuf_memcmp</referencedby>
        <referencedby refid="group__pbuf_1ga18c164a6e4a24d89ea9eb7571a886448" compoundref="pbuf_8c" startline="1405" endline="1418">pbuf_memfind</referencedby>
        <referencedby refid="group__pbuf_1ga50abfe830a33a1a47a562febee66015d" compoundref="pbuf_8c" startline="493" endline="555">pbuf_realloc</referencedby>
        <referencedby refid="pbuf_8c_1a9ba3f7b705309ceadb147692fd5a1c7d" compoundref="pbuf_8c" startline="1432" endline="1443">pbuf_strstr</referencedby>
        <referencedby refid="group__pbuf_1gae1cf2bf7454ff87ff377b0b2262f9b44" compoundref="pbuf_8c" startline="1194" endline="1214">pbuf_take_at</referencedby>
      </memberdef>
      <memberdef kind="variable" id="structpbuf_1afd7bff5210a022424caa97d2f25fe8e6" prot="public" static="no" mutable="no">
        <type><ref refid="group__compiler__abstraction_1ga4caecabca98b43919dd11be1c0d4cd8e" kindref="member">u8_t</ref></type>
        <definition>u8_t pbuf::type</definition>
        <argsstring></argsstring>
        <name>type</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>pbuf_type as u8_t instead of enum to save space </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/pbuf.h" line="162" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/pbuf.h" bodystart="162" bodyend="-1"/>
        <referencedby refid="group__pbuf_1gacfcb0a2af918658ba0afe36499c65f47" compoundref="pbuf_8c" startline="248" endline="405">pbuf_alloc</referencedby>
        <referencedby refid="group__pbuf_1gab0dd696fb4b6bc65e548944584f1738b" compoundref="pbuf_8c" startline="715" endline="792">pbuf_free</referencedby>
        <referencedby refid="group__pbuf_1ga50abfe830a33a1a47a562febee66015d" compoundref="pbuf_8c" startline="493" endline="555">pbuf_realloc</referencedby>
      </memberdef>
      </sectiondef>
    <briefdescription>
    </briefdescription>
    <detaileddescription>
<para>Main packet buffer struct </para>
    </detaileddescription>
    <collaborationgraph>
      <node id="1">
        <label>pbuf</label>
        <link refid="structpbuf"/>
        <childnode refid="1" relation="usage">
          <edgelabel>+next</edgelabel>
        </childnode>
      </node>
    </collaborationgraph>
    <location file="C:/Dev/git/UbixOS/sys/include/net/pbuf.h" line="142" column="11" bodyfile="C:/Dev/git/UbixOS/sys/include/net/pbuf.h" bodystart="142" bodyend="173"/>
    <listofallmembers>
      <member refid="structpbuf_1aa4d1af2cab3d9280d29212095b5b872a" prot="public" virt="non-virtual"><scope>pbuf</scope><name>flags</name></member>
      <member refid="structpbuf_1a6f82449625e36e294f5d210268c0703f" prot="public" virt="non-virtual"><scope>pbuf</scope><name>len</name></member>
      <member refid="structpbuf_1a5e5763c94fd18d78937b0b58ce7df341" prot="public" virt="non-virtual"><scope>pbuf</scope><name>next</name></member>
      <member refid="structpbuf_1a8d32dc3e964369d4eec638fc37fbc460" prot="public" virt="non-virtual"><scope>pbuf</scope><name>payload</name></member>
      <member refid="structpbuf_1a18e2c02942feb1baa3756fcd585b6731" prot="public" virt="non-virtual"><scope>pbuf</scope><name>ref</name></member>
      <member refid="structpbuf_1a5259e7ec29bab9c0999b64f2e86b411f" prot="public" virt="non-virtual"><scope>pbuf</scope><name>tot_len</name></member>
      <member refid="structpbuf_1afd7bff5210a022424caa97d2f25fe8e6" prot="public" virt="non-virtual"><scope>pbuf</scope><name>type</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>