Newer
Older
UbixOS / doc / xml / structmqtt__client__t.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="structmqtt__client__t" kind="struct" language="C++" prot="public">
    <compoundname>mqtt_client_t</compoundname>
    <includes refid="mqtt_8h" local="no">mqtt.h</includes>
      <sectiondef kind="public-attrib">
      <memberdef kind="variable" id="structmqtt__client__t_1a316df91be3e227081eb65db5ae6acc95" prot="public" static="no" mutable="no">
        <type>struct tcp_pcb *</type>
        <definition>struct tcp_pcb* mqtt_client_t::conn</definition>
        <argsstring></argsstring>
        <name>conn</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/apps/mqtt.h" line="189" column="16" bodyfile="C:/Dev/git/UbixOS/sys/include/net/apps/mqtt.h" bodystart="189" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="structmqtt__client__t_1a5823d082e96704fd7f6dac15cbeceb3b" prot="public" static="no" mutable="no">
        <type><ref refid="group__compiler__abstraction_1ga4caecabca98b43919dd11be1c0d4cd8e" kindref="member">u8_t</ref></type>
        <definition>u8_t mqtt_client_t::conn_state</definition>
        <argsstring></argsstring>
        <name>conn_state</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>Connection state </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/apps/mqtt.h" line="188" column="8" bodyfile="C:/Dev/git/UbixOS/sys/include/net/apps/mqtt.h" bodystart="188" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="structmqtt__client__t_1af9243ec4301c1b135bb558b9bc14fe36" prot="public" static="no" mutable="no">
        <type>void *</type>
        <definition>void* mqtt_client_t::connect_arg</definition>
        <argsstring></argsstring>
        <name>connect_arg</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>Connection callback </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/apps/mqtt.h" line="191" column="8" bodyfile="C:/Dev/git/UbixOS/sys/include/net/apps/mqtt.h" bodystart="191" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="structmqtt__client__t_1aefe3a47f733efa1219d1b9e234a39815" prot="public" static="no" mutable="no">
        <type><ref refid="mqtt_8h_1a8558743bdb7d599a93844fbc56c9029f" kindref="member">mqtt_connection_cb_t</ref></type>
        <definition>mqtt_connection_cb_t mqtt_client_t::connect_cb</definition>
        <argsstring></argsstring>
        <name>connect_cb</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/apps/mqtt.h" line="192" column="24" bodyfile="C:/Dev/git/UbixOS/sys/include/net/apps/mqtt.h" bodystart="192" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="structmqtt__client__t_1a7faa0bf23ea59555ac197e92373eb5af" prot="public" static="no" mutable="no">
        <type><ref refid="group__compiler__abstraction_1ga77570ac4fcab86864fa1916e55676da2" kindref="member">u16_t</ref></type>
        <definition>u16_t mqtt_client_t::cyclic_tick</definition>
        <argsstring></argsstring>
        <name>cyclic_tick</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>Timers and timeouts </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/apps/mqtt.h" line="180" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/apps/mqtt.h" bodystart="180" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="structmqtt__client__t_1a3dc93a43df32d297cc5ab677c2d7fcb0" prot="public" static="no" mutable="no">
        <type><ref refid="mqtt_8h_1afec7e75fe6a746eef9ca411463446c81" kindref="member">mqtt_incoming_data_cb_t</ref></type>
        <definition>mqtt_incoming_data_cb_t mqtt_client_t::data_cb</definition>
        <argsstring></argsstring>
        <name>data_cb</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>Incoming data callback </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/apps/mqtt.h" line="198" column="27" bodyfile="C:/Dev/git/UbixOS/sys/include/net/apps/mqtt.h" bodystart="198" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="structmqtt__client__t_1ad7a160f23e5585a1d950e9cc5ab77d29" prot="public" static="no" mutable="no">
        <type>void *</type>
        <definition>void* mqtt_client_t::inpub_arg</definition>
        <argsstring></argsstring>
        <name>inpub_arg</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/apps/mqtt.h" line="196" column="8" bodyfile="C:/Dev/git/UbixOS/sys/include/net/apps/mqtt.h" bodystart="196" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="structmqtt__client__t_1aca6ec3ce9a992facc4f1e94492cff459" prot="public" static="no" mutable="no">
        <type><ref refid="group__compiler__abstraction_1ga77570ac4fcab86864fa1916e55676da2" kindref="member">u16_t</ref></type>
        <definition>u16_t mqtt_client_t::inpub_pkt_id</definition>
        <argsstring></argsstring>
        <name>inpub_pkt_id</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>Packet identifier of pending incoming publish </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/apps/mqtt.h" line="186" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/apps/mqtt.h" bodystart="186" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="structmqtt__client__t_1a5d4e782a5ebce7f42909690a245e39cb" prot="public" static="no" mutable="no">
        <type><ref refid="group__compiler__abstraction_1ga77570ac4fcab86864fa1916e55676da2" kindref="member">u16_t</ref></type>
        <definition>u16_t mqtt_client_t::keep_alive</definition>
        <argsstring></argsstring>
        <name>keep_alive</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/apps/mqtt.h" line="181" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/apps/mqtt.h" bodystart="181" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="structmqtt__client__t_1a88fdc82ad31ecb15e4adaeb5363c3ca1" prot="public" static="no" mutable="no">
        <type><ref refid="group__compiler__abstraction_1ga4c14294869aceba3ef9d4c0c302d0f33" kindref="member">u32_t</ref></type>
        <definition>u32_t mqtt_client_t::msg_idx</definition>
        <argsstring></argsstring>
        <name>msg_idx</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>Input </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/apps/mqtt.h" line="201" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/apps/mqtt.h" bodystart="201" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="structmqtt__client__t_1a99a47e18b78a99284ec7a568172093e2" prot="public" static="no" mutable="no">
        <type>struct <ref refid="structmqtt__ringbuf__t" kindref="compound">mqtt_ringbuf_t</ref></type>
        <definition>struct mqtt_ringbuf_t mqtt_client_t::output</definition>
        <argsstring></argsstring>
        <name>output</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>Output ring-buffer </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/apps/mqtt.h" line="202" column="8" bodyfile="C:/Dev/git/UbixOS/sys/include/net/apps/mqtt.h" bodystart="204" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="structmqtt__client__t_1a2108d22084f33f3eb656e13bdca3b545" prot="public" static="no" mutable="no">
        <type>struct <ref refid="structmqtt__request__t" kindref="compound">mqtt_request_t</ref> *</type>
        <definition>struct mqtt_request_t* mqtt_client_t::pend_req_queue</definition>
        <argsstring></argsstring>
        <name>pend_req_queue</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>Pending requests to server </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/apps/mqtt.h" line="194" column="23" bodyfile="C:/Dev/git/UbixOS/sys/include/net/apps/mqtt.h" bodystart="194" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="structmqtt__client__t_1a0dcc0d539bc0418f3a5eb559a7f0bb1f" prot="public" static="no" mutable="no">
        <type><ref refid="group__compiler__abstraction_1ga77570ac4fcab86864fa1916e55676da2" kindref="member">u16_t</ref></type>
        <definition>u16_t mqtt_client_t::pkt_id_seq</definition>
        <argsstring></argsstring>
        <name>pkt_id_seq</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>Packet identifier generator </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/apps/mqtt.h" line="184" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/apps/mqtt.h" bodystart="184" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="structmqtt__client__t_1afb1500ccfda7f232274c97c717901331" prot="public" static="no" mutable="no">
        <type><ref refid="mqtt_8h_1a7116bb85255394cec4b1d9fa38842c29" kindref="member">mqtt_incoming_publish_cb_t</ref></type>
        <definition>mqtt_incoming_publish_cb_t mqtt_client_t::pub_cb</definition>
        <argsstring></argsstring>
        <name>pub_cb</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/apps/mqtt.h" line="199" column="30" bodyfile="C:/Dev/git/UbixOS/sys/include/net/apps/mqtt.h" bodystart="199" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="structmqtt__client__t_1ae165d8f9a3f1264f9f69aaa745b73e9f" prot="public" static="no" mutable="no">
        <type>struct <ref refid="structmqtt__request__t" kindref="compound">mqtt_request_t</ref></type>
        <definition>struct mqtt_request_t mqtt_client_t::req_list[MQTT_REQ_MAX_IN_FLIGHT]</definition>
        <argsstring>[MQTT_REQ_MAX_IN_FLIGHT]</argsstring>
        <name>req_list</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/apps/mqtt.h" line="194" column="23" bodyfile="C:/Dev/git/UbixOS/sys/include/net/apps/mqtt.h" bodystart="195" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="structmqtt__client__t_1a562c52abb06270cac6b5ea462c3b8c5f" prot="public" static="no" mutable="no">
        <type><ref refid="group__compiler__abstraction_1ga4caecabca98b43919dd11be1c0d4cd8e" kindref="member">u8_t</ref></type>
        <definition>u8_t mqtt_client_t::rx_buffer[MQTT_VAR_HEADER_BUFFER_LEN]</definition>
        <argsstring>[MQTT_VAR_HEADER_BUFFER_LEN]</argsstring>
        <name>rx_buffer</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/apps/mqtt.h" line="202" column="8" bodyfile="C:/Dev/git/UbixOS/sys/include/net/apps/mqtt.h" bodystart="202" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="structmqtt__client__t_1aa0e3555ddd793ead6f731aa76c0eea6d" prot="public" static="no" mutable="no">
        <type><ref refid="group__compiler__abstraction_1ga77570ac4fcab86864fa1916e55676da2" kindref="member">u16_t</ref></type>
        <definition>u16_t mqtt_client_t::server_watchdog</definition>
        <argsstring></argsstring>
        <name>server_watchdog</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/apps/mqtt.h" line="182" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/apps/mqtt.h" bodystart="182" bodyend="-1"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
    </briefdescription>
    <detaileddescription>
<para>MQTT client </para>
    </detaileddescription>
    <collaborationgraph>
      <node id="3">
        <label>mqtt_ringbuf_t</label>
        <link refid="structmqtt__ringbuf__t"/>
      </node>
      <node id="1">
        <label>mqtt_client_t</label>
        <link refid="structmqtt__client__t"/>
        <childnode refid="2" relation="usage">
          <edgelabel>+pend_req_queue</edgelabel>
          <edgelabel>+req_list</edgelabel>
        </childnode>
        <childnode refid="1" relation="usage">
          <edgelabel>+connect_cb</edgelabel>
        </childnode>
        <childnode refid="3" relation="usage">
          <edgelabel>+output</edgelabel>
        </childnode>
      </node>
      <node id="2">
        <label>mqtt_request_t</label>
        <link refid="structmqtt__request__t"/>
        <childnode refid="2" relation="usage">
          <edgelabel>+next</edgelabel>
        </childnode>
      </node>
    </collaborationgraph>
    <location file="C:/Dev/git/UbixOS/sys/include/net/apps/mqtt.h" line="178" column="1" bodyfile="C:/Dev/git/UbixOS/sys/include/net/apps/mqtt.h" bodystart="177" bodyend="205"/>
    <listofallmembers>
      <member refid="structmqtt__client__t_1a316df91be3e227081eb65db5ae6acc95" prot="public" virt="non-virtual"><scope>mqtt_client_t</scope><name>conn</name></member>
      <member refid="structmqtt__client__t_1a5823d082e96704fd7f6dac15cbeceb3b" prot="public" virt="non-virtual"><scope>mqtt_client_t</scope><name>conn_state</name></member>
      <member refid="structmqtt__client__t_1af9243ec4301c1b135bb558b9bc14fe36" prot="public" virt="non-virtual"><scope>mqtt_client_t</scope><name>connect_arg</name></member>
      <member refid="structmqtt__client__t_1aefe3a47f733efa1219d1b9e234a39815" prot="public" virt="non-virtual"><scope>mqtt_client_t</scope><name>connect_cb</name></member>
      <member refid="structmqtt__client__t_1a7faa0bf23ea59555ac197e92373eb5af" prot="public" virt="non-virtual"><scope>mqtt_client_t</scope><name>cyclic_tick</name></member>
      <member refid="structmqtt__client__t_1a3dc93a43df32d297cc5ab677c2d7fcb0" prot="public" virt="non-virtual"><scope>mqtt_client_t</scope><name>data_cb</name></member>
      <member refid="structmqtt__client__t_1ad7a160f23e5585a1d950e9cc5ab77d29" prot="public" virt="non-virtual"><scope>mqtt_client_t</scope><name>inpub_arg</name></member>
      <member refid="structmqtt__client__t_1aca6ec3ce9a992facc4f1e94492cff459" prot="public" virt="non-virtual"><scope>mqtt_client_t</scope><name>inpub_pkt_id</name></member>
      <member refid="structmqtt__client__t_1a5d4e782a5ebce7f42909690a245e39cb" prot="public" virt="non-virtual"><scope>mqtt_client_t</scope><name>keep_alive</name></member>
      <member refid="structmqtt__client__t_1a88fdc82ad31ecb15e4adaeb5363c3ca1" prot="public" virt="non-virtual"><scope>mqtt_client_t</scope><name>msg_idx</name></member>
      <member refid="structmqtt__client__t_1a99a47e18b78a99284ec7a568172093e2" prot="public" virt="non-virtual"><scope>mqtt_client_t</scope><name>output</name></member>
      <member refid="structmqtt__client__t_1a2108d22084f33f3eb656e13bdca3b545" prot="public" virt="non-virtual"><scope>mqtt_client_t</scope><name>pend_req_queue</name></member>
      <member refid="structmqtt__client__t_1a0dcc0d539bc0418f3a5eb559a7f0bb1f" prot="public" virt="non-virtual"><scope>mqtt_client_t</scope><name>pkt_id_seq</name></member>
      <member refid="structmqtt__client__t_1afb1500ccfda7f232274c97c717901331" prot="public" virt="non-virtual"><scope>mqtt_client_t</scope><name>pub_cb</name></member>
      <member refid="structmqtt__client__t_1ae165d8f9a3f1264f9f69aaa745b73e9f" prot="public" virt="non-virtual"><scope>mqtt_client_t</scope><name>req_list</name></member>
      <member refid="structmqtt__client__t_1a562c52abb06270cac6b5ea462c3b8c5f" prot="public" virt="non-virtual"><scope>mqtt_client_t</scope><name>rx_buffer</name></member>
      <member refid="structmqtt__client__t_1aa0e3555ddd793ead6f731aa76c0eea6d" prot="public" virt="non-virtual"><scope>mqtt_client_t</scope><name>server_watchdog</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>