coreMQTT v2.1.1
MQTT 3.1.1 Client Library
Enumerated Types

Enumerated types of the MQTT library. More...

Enumerations

enum  MQTTConnectionStatus_t { MQTTNotConnected , MQTTConnected }
 Values indicating if an MQTT connection exists. More...
 
enum  MQTTPublishState_t {
  MQTTStateNull = 0 , MQTTPublishSend , MQTTPubAckSend , MQTTPubRecSend ,
  MQTTPubRelSend , MQTTPubCompSend , MQTTPubAckPending , MQTTPubRecPending ,
  MQTTPubRelPending , MQTTPubCompPending , MQTTPublishDone
}
 The state of QoS 1 or QoS 2 MQTT publishes, used in the state engine. More...
 
enum  MQTTPubAckType_t { MQTTPuback , MQTTPubrec , MQTTPubrel , MQTTPubcomp }
 Packet types used in acknowledging QoS 1 or QoS 2 publishes. More...
 
enum  MQTTSubAckStatus_t { MQTTSubAckSuccessQos0 = 0x00 , MQTTSubAckSuccessQos1 = 0x01 , MQTTSubAckSuccessQos2 = 0x02 , MQTTSubAckFailure = 0x80 }
 The status codes in the SUBACK response to a subscription request. More...
 
enum  MQTTStatus_t {
  MQTTSuccess = 0 , MQTTBadParameter , MQTTNoMemory , MQTTSendFailed ,
  MQTTRecvFailed , MQTTBadResponse , MQTTServerRefused , MQTTNoDataAvailable ,
  MQTTIllegalState , MQTTStateCollision , MQTTKeepAliveTimeout , MQTTNeedMoreBytes
}
 Return codes from MQTT functions. More...
 
enum  MQTTQoS_t { MQTTQoS0 = 0 , MQTTQoS1 = 1 , MQTTQoS2 = 2 }
 MQTT Quality of Service values. More...
 

Detailed Description

Enumerated types of the MQTT library.

Enumeration Type Documentation

◆ MQTTConnectionStatus_t

Values indicating if an MQTT connection exists.

Enumerator
MQTTNotConnected 

MQTT Connection is inactive.

MQTTConnected 

MQTT Connection is active.

◆ MQTTPublishState_t

The state of QoS 1 or QoS 2 MQTT publishes, used in the state engine.

Enumerator
MQTTStateNull 

An empty state with no corresponding PUBLISH.

MQTTPublishSend 

The library will send an outgoing PUBLISH packet.

MQTTPubAckSend 

The library will send a PUBACK for a received PUBLISH.

MQTTPubRecSend 

The library will send a PUBREC for a received PUBLISH.

MQTTPubRelSend 

The library will send a PUBREL for a received PUBREC.

MQTTPubCompSend 

The library will send a PUBCOMP for a received PUBREL.

MQTTPubAckPending 

The library is awaiting a PUBACK for an outgoing PUBLISH.

MQTTPubRecPending 

The library is awaiting a PUBREC for an outgoing PUBLISH.

MQTTPubRelPending 

The library is awaiting a PUBREL for an incoming PUBLISH.

MQTTPubCompPending 

The library is awaiting a PUBCOMP for an outgoing PUBLISH.

MQTTPublishDone 

The PUBLISH has been completed.

◆ MQTTPubAckType_t

Packet types used in acknowledging QoS 1 or QoS 2 publishes.

Enumerator
MQTTPuback 

PUBACKs are sent in response to a QoS 1 PUBLISH.

MQTTPubrec 

PUBRECs are sent in response to a QoS 2 PUBLISH.

MQTTPubrel 

PUBRELs are sent in response to a PUBREC.

MQTTPubcomp 

PUBCOMPs are sent in response to a PUBREL.

◆ MQTTSubAckStatus_t

The status codes in the SUBACK response to a subscription request.

Enumerator
MQTTSubAckSuccessQos0 

Success with a maximum delivery at QoS 0.

MQTTSubAckSuccessQos1 

Success with a maximum delivery at QoS 1.

MQTTSubAckSuccessQos2 

Success with a maximum delivery at QoS 2.

MQTTSubAckFailure 

Failure.

◆ MQTTStatus_t

Return codes from MQTT functions.

Enumerator
MQTTSuccess 

Function completed successfully.

MQTTBadParameter 

At least one parameter was invalid.

MQTTNoMemory 

A provided buffer was too small.

MQTTSendFailed 

The transport send function failed.

MQTTRecvFailed 

The transport receive function failed.

MQTTBadResponse 

An invalid packet was received from the server.

MQTTServerRefused 

The server refused a CONNECT or SUBSCRIBE.

MQTTNoDataAvailable 

No data available from the transport interface.

MQTTIllegalState 

An illegal state in the state record.

MQTTStateCollision 

A collision with an existing state record entry.

MQTTKeepAliveTimeout 

Timeout while waiting for PINGRESP.

MQTTNeedMoreBytes 

MQTT_ProcessLoop/MQTT_ReceiveLoop has received incomplete data; it should be called again (probably after a delay).

◆ MQTTQoS_t

enum MQTTQoS_t

MQTT Quality of Service values.

Enumerator
MQTTQoS0 

Delivery at most once.

MQTTQoS1 

Delivery at least once.

MQTTQoS2 

Delivery exactly once.