MQTT API
==========

Yimmo MQTT public API.

.. toctree::
  :hidden:
  :maxdepth: 3

  index

.. contents:: Contents
  :local:




---------------------------------------------------------------
Flags
---------------------------------------------------------------



.. c:macro:: YMO_MQTT_FIXED_HDR_TYPE_MASK

   http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc398718020


   .. code-block:: c
      :caption: Definition
   
      #define YMO_MQTT_FIXED_HDR_TYPE_MASK 0xF0


.. c:macro:: YMO_MQTT_FIXED_HDR_FLAG_MASK

   http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc398718020


   .. code-block:: c
      :caption: Definition
   
      #define YMO_MQTT_FIXED_HDR_FLAG_MASK 0x0F


---------------------------------------------------------------
Types
---------------------------------------------------------------



.. c:type:: ymo_mqtt_state

   


   .. code-block:: c
      :caption: Definition
   
      YMO_ENUM8_TYPEDEF(ymo_mqtt_state) {
          YMO_MQTT_STATE_CONNECTING,
          YMO_MQTT_STATE_AWAITING_AUTHENTICATION,
          YMO_MQTT_STATE_CONNECTED,
          YMO_MQTT_STATE_DISCONNECTING,
          YMO_MQTT_STATE_DISCONNECTED
      } YMO_ENUM8_AS(ymo_mqtt_state_t);


MQTT Control Packet Type
..........................

See http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc398718021
for more info.




.. c:macro:: YMO_MQTT_CONNECT

   


   .. code-block:: c
      :caption: Definition
   
      #define YMO_MQTT_CONNECT        0x10


.. c:macro:: YMO_MQTT_CONNACK

   


   .. code-block:: c
      :caption: Definition
   
      #define YMO_MQTT_CONNACK        0x20


.. c:macro:: YMO_MQTT_PUBLISH

   


   .. code-block:: c
      :caption: Definition
   
      #define YMO_MQTT_PUBLISH        0x30


.. c:macro:: YMO_MQTT_PUBACK

   


   .. code-block:: c
      :caption: Definition
   
      #define YMO_MQTT_PUBACK         0x40


.. c:macro:: YMO_MQTT_PUBREC

   


   .. code-block:: c
      :caption: Definition
   
      #define YMO_MQTT_PUBREC         0x50


.. c:macro:: YMO_MQTT_PUBREL

   


   .. code-block:: c
      :caption: Definition
   
      #define YMO_MQTT_PUBREL         0x60


.. c:macro:: YMO_MQTT_PUBCOMP

   


   .. code-block:: c
      :caption: Definition
   
      #define YMO_MQTT_PUBCOMP        0x70


.. c:macro:: YMO_MQTT_SUBSCRIBE

   


   .. code-block:: c
      :caption: Definition
   
      #define YMO_MQTT_SUBSCRIBE      0x80


.. c:macro:: YMO_MQTT_SUBACK

   


   .. code-block:: c
      :caption: Definition
   
      #define YMO_MQTT_SUBACK         0x90


.. c:macro:: YMO_MQTT_UNSUBSCRIBE

   


   .. code-block:: c
      :caption: Definition
   
      #define YMO_MQTT_UNSUBSCRIBE    0xA0


.. c:macro:: YMO_MQTT_UNSUBACK

   


   .. code-block:: c
      :caption: Definition
   
      #define YMO_MQTT_UNSUBACK       0xB0


.. c:macro:: YMO_MQTT_PINGREQ

   


   .. code-block:: c
      :caption: Definition
   
      #define YMO_MQTT_PINGREQ        0xC0


.. c:macro:: YMO_MQTT_PINGRESP

   


   .. code-block:: c
      :caption: Definition
   
      #define YMO_MQTT_PINGRESP       0xD0


.. c:macro:: YMO_MQTT_DISCONNECT

   


   .. code-block:: c
      :caption: Definition
   
      #define YMO_MQTT_DISCONNECT     0xE0


---------------------------------------------------------------
MQTT Protocol Management
---------------------------------------------------------------



.. c:function:: ymo_proto_t* ymo_proto_mqtt_create(void)