Newer
Older
UbixOS / doc / xml / structicmp__echo__hdr.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="structicmp__echo__hdr" kind="struct" language="C++" prot="public">
    <compoundname>icmp_echo_hdr</compoundname>
    <includes refid="prot_2icmp_8h" local="no">icmp.h</includes>
      <sectiondef kind="public-func">
      <memberdef kind="function" id="structicmp__echo__hdr_1a5d1bdfcc4a8bdd58513ecbaea368c1ad" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type></type>
        <definition>icmp_echo_hdr::PACK_STRUCT_FIELD</definition>
        <argsstring>(u16_t chksum)</argsstring>
        <name>PACK_STRUCT_FIELD</name>
        <param>
          <type><ref refid="group__compiler__abstraction_1ga77570ac4fcab86864fa1916e55676da2" kindref="member">u16_t</ref></type>
          <declname>chksum</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/prot/icmp.h" line="72" column="3"/>
      </memberdef>
      <memberdef kind="function" id="structicmp__echo__hdr_1a35dd6758d625e1542599175e65235362" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type></type>
        <definition>icmp_echo_hdr::PACK_STRUCT_FIELD</definition>
        <argsstring>(u16_t id)</argsstring>
        <name>PACK_STRUCT_FIELD</name>
        <param>
          <type><ref refid="group__compiler__abstraction_1ga77570ac4fcab86864fa1916e55676da2" kindref="member">u16_t</ref></type>
          <declname>id</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/prot/icmp.h" line="73" column="3"/>
      </memberdef>
      <memberdef kind="function" id="structicmp__echo__hdr_1a2d2722057bc87fa0afb495ba6716eb57" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type></type>
        <definition>icmp_echo_hdr::PACK_STRUCT_FIELD</definition>
        <argsstring>(u16_t seqno)</argsstring>
        <name>PACK_STRUCT_FIELD</name>
        <param>
          <type><ref refid="group__compiler__abstraction_1ga77570ac4fcab86864fa1916e55676da2" kindref="member">u16_t</ref></type>
          <declname>seqno</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/prot/icmp.h" line="74" column="3"/>
      </memberdef>
      <memberdef kind="function" id="structicmp__echo__hdr_1adcbacb52889e263a973944ec5fbd6b55" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type></type>
        <definition>icmp_echo_hdr::PACK_STRUCT_FLD_8</definition>
        <argsstring>(u8_t code)</argsstring>
        <name>PACK_STRUCT_FLD_8</name>
        <param>
          <type><ref refid="group__compiler__abstraction_1ga4caecabca98b43919dd11be1c0d4cd8e" kindref="member">u8_t</ref></type>
          <declname>code</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/prot/icmp.h" line="71" column="3"/>
      </memberdef>
      <memberdef kind="function" id="structicmp__echo__hdr_1a0e52c238eaeadcb6f4fd9b8136488a66" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type></type>
        <definition>icmp_echo_hdr::PACK_STRUCT_FLD_8</definition>
        <argsstring>(u8_t type)</argsstring>
        <name>PACK_STRUCT_FLD_8</name>
        <param>
          <type><ref refid="group__compiler__abstraction_1ga4caecabca98b43919dd11be1c0d4cd8e" kindref="member">u8_t</ref></type>
          <declname>type</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/prot/icmp.h" line="70" column="3"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
    </briefdescription>
    <detaileddescription>
<para>This is the standard ICMP header only that the u32_t data is split to two u16_t like ICMP echo needs it. This header is also used for other ICMP types that do not use the data part. </para>
    </detaileddescription>
    <collaborationgraph>
      <node id="1">
        <label>icmp_echo_hdr</label>
        <link refid="structicmp__echo__hdr"/>
      </node>
    </collaborationgraph>
    <location file="C:/Dev/git/UbixOS/sys/include/net/prot/icmp.h" line="69" column="20" bodyfile="C:/Dev/git/UbixOS/sys/include/net/prot/icmp.h" bodystart="69" bodyend="75"/>
    <listofallmembers>
      <member refid="structicmp__echo__hdr_1a5d1bdfcc4a8bdd58513ecbaea368c1ad" prot="public" virt="non-virtual"><scope>icmp_echo_hdr</scope><name>PACK_STRUCT_FIELD</name></member>
      <member refid="structicmp__echo__hdr_1a35dd6758d625e1542599175e65235362" prot="public" virt="non-virtual"><scope>icmp_echo_hdr</scope><name>PACK_STRUCT_FIELD</name></member>
      <member refid="structicmp__echo__hdr_1a2d2722057bc87fa0afb495ba6716eb57" prot="public" virt="non-virtual"><scope>icmp_echo_hdr</scope><name>PACK_STRUCT_FIELD</name></member>
      <member refid="structicmp__echo__hdr_1a0e52c238eaeadcb6f4fd9b8136488a66" prot="public" virt="non-virtual"><scope>icmp_echo_hdr</scope><name>PACK_STRUCT_FLD_8</name></member>
      <member refid="structicmp__echo__hdr_1adcbacb52889e263a973944ec5fbd6b55" prot="public" virt="non-virtual"><scope>icmp_echo_hdr</scope><name>PACK_STRUCT_FLD_8</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>