"Global Data Types and Functions"

Classes
struct	CC_Mqtt311MessageInfo
	Received message information. More...

Macros
#define	CC_MQTT311_CLIENT_MAJOR_VERSION   1U
	Major verion of the library.
#define	CC_MQTT311_CLIENT_MAKE_VERSION(major_, minor_, patch_)
	Macro to create numeric version as single unsigned number.
#define	CC_MQTT311_CLIENT_MINOR_VERSION   0U
	Minor verion of the library.
#define	CC_MQTT311_CLIENT_PATCH_VERSION   6U
	Patch level of the library.
#define	CC_MQTT311_CLIENT_VERSION   CC_MQTT311_CLIENT_MAKE_VERSION(CC_MQTT311_CLIENT_MAJOR_VERSION, CC_MQTT311_CLIENT_MINOR_VERSION, CC_MQTT311_CLIENT_PATCH_VERSION)
	Version of the library as single numeric value.

Enumerations
enum	CC_Mqtt311AsyncOpStatus {   CC_Mqtt311AsyncOpStatus_Complete = 0 , CC_Mqtt311AsyncOpStatus_InternalError = 1 , CC_Mqtt311AsyncOpStatus_Timeout = 2 , CC_Mqtt311AsyncOpStatus_ProtocolError = 3 ,   CC_Mqtt311AsyncOpStatus_Aborted = 4 , CC_Mqtt311AsyncOpStatus_BrokerDisconnected = 5 , CC_Mqtt311AsyncOpStatus_OutOfMemory = 6 , CC_Mqtt311AsyncOpStatus_BadParam = 7 ,   CC_Mqtt311AsyncOpStatus_ValuesLimit }
	Status of the asynchronous operation. More...
enum	CC_Mqtt311BrokerDisconnectReason { CC_Mqtt311BrokerDisconnectReason_NoBrokerResponse = 0 , CC_Mqtt311BrokerDisconnectReason_InternalError = 1 , CC_Mqtt311BrokerDisconnectReason_ProtocolError = 2 , CC_Mqtt311BrokerDisconnectReason_ValuesLimit }
	Reason for reporting unsolicited broker disconnection. More...
enum	CC_Mqtt311ErrorCode {   CC_Mqtt311ErrorCode_Success = 0 , CC_Mqtt311ErrorCode_InternalError = 1 , CC_Mqtt311ErrorCode_NotIntitialized = 2 , CC_Mqtt311ErrorCode_Busy = 3 ,   CC_Mqtt311ErrorCode_NotConnected = 4 , CC_Mqtt311ErrorCode_AlreadyConnected = 5 , CC_Mqtt311ErrorCode_BadParam = 6 , CC_Mqtt311ErrorCode_InsufficientConfig = 7 ,   CC_Mqtt311ErrorCode_OutOfMemory = 8 , CC_Mqtt311ErrorCode_BufferOverflow = 9 , CC_Mqtt311ErrorCode_NotSupported = 10 , CC_Mqtt311ErrorCode_RetryLater = 11 ,   CC_Mqtt311ErrorCode_Disconnecting = 12 , CC_Mqtt311ErrorCode_NetworkDisconnected = 13 , CC_Mqtt311ErrorCode_PreparationLocked = 14 , CC_Mqtt311ErrorCode_ValuesLimit }
	Error code returned by various API functions. More...
enum	CC_Mqtt311QoS { CC_Mqtt311QoS_AtMostOnceDelivery = 0 , CC_Mqtt311QoS_AtLeastOnceDelivery = 1 , CC_Mqtt311QoS_ExactlyOnceDelivery = 2 , CC_Mqtt311QoS_ValuesLimit }
	Quality of Service. More...

Detailed Description

Enumeration Type Documentation

CC_Mqtt311AsyncOpStatus

enum CC_Mqtt311AsyncOpStatus

Status of the asynchronous operation.

Enumerator
CC_Mqtt311AsyncOpStatus_Complete	The requested operation has been completed, refer to reported extra details for information.
CC_Mqtt311AsyncOpStatus_InternalError	Internal library error, please submit bug report
CC_Mqtt311AsyncOpStatus_Timeout	The required response from broker hasn't been received in time.
CC_Mqtt311AsyncOpStatus_ProtocolError	The broker's response doesn't comply with MQTT311 specification.
CC_Mqtt311AsyncOpStatus_Aborted	The operation has been aborted before completion due to client's side operation.
CC_Mqtt311AsyncOpStatus_BrokerDisconnected	The operation has been aborted before completion due to broker's disconnection.
CC_Mqtt311AsyncOpStatus_OutOfMemory	The client library wasn't able to allocate necessary memory.
CC_Mqtt311AsyncOpStatus_BadParam	Bad value has been returned from the relevant callback.
CC_Mqtt311AsyncOpStatus_ValuesLimit	Limit for the values.

CC_Mqtt311BrokerDisconnectReason

enum CC_Mqtt311BrokerDisconnectReason

Reason for reporting unsolicited broker disconnection.

Enumerator
CC_Mqtt311BrokerDisconnectReason_NoBrokerResponse	No messages from the broker and no response to PINGREQ.
CC_Mqtt311BrokerDisconnectReason_InternalError	The library encountered internal error and there is a need to close network connection.
CC_Mqtt311BrokerDisconnectReason_ProtocolError	Protocol error was detected.
CC_Mqtt311BrokerDisconnectReason_ValuesLimit	Limit for the values.

CC_Mqtt311ErrorCode

enum CC_Mqtt311ErrorCode

Error code returned by various API functions.

Enumerator
CC_Mqtt311ErrorCode_Success	The requested function executed successfully.
CC_Mqtt311ErrorCode_InternalError	Internal library error, please submit bug report
CC_Mqtt311ErrorCode_NotIntitialized	The allocated client hasn't been initialized.
CC_Mqtt311ErrorCode_Busy	The client library is in the middle of previous operation(s), cannot start a new one.
CC_Mqtt311ErrorCode_NotConnected	The client library is not connected to the broker. Returned by operations that require connection to the broker.
CC_Mqtt311ErrorCode_AlreadyConnected	The client library is already connected to the broker, cannot perform connection operation.
CC_Mqtt311ErrorCode_BadParam	Bad parameter is passed to the function.
CC_Mqtt311ErrorCode_InsufficientConfig	The required configuration hasn't been performed.
CC_Mqtt311ErrorCode_OutOfMemory	Memory allocation failed.
CC_Mqtt311ErrorCode_BufferOverflow	Output buffer is too short.
CC_Mqtt311ErrorCode_NotSupported	Feature is not supported.
CC_Mqtt311ErrorCode_RetryLater	Retry in next event loop iteration.
CC_Mqtt311ErrorCode_Disconnecting	The client is in "disconnecting" state, (re)connect is required in the next iteration loop.
CC_Mqtt311ErrorCode_NetworkDisconnected	When network is disconnected issueing new ops is not accepted.
CC_Mqtt311ErrorCode_PreparationLocked	Another operation is being prepared, cannot create a new one without performing "send" or "cancel".
CC_Mqtt311ErrorCode_ValuesLimit	Limit for the values.

CC_Mqtt311QoS

enum CC_Mqtt311QoS

Quality of Service.

Enumerator
CC_Mqtt311QoS_AtMostOnceDelivery	QoS=0. At most once delivery.
CC_Mqtt311QoS_AtLeastOnceDelivery	QoS=1. At least once delivery.
CC_Mqtt311QoS_ExactlyOnceDelivery	QoS=2. Exactly once delivery.
CC_Mqtt311QoS_ValuesLimit	Limit for the values.