Macros | Typedefs | Enumerations
MyQtt Types: Types definitions used across MyQtt Library.

Macros

#define QUEUE_PRIORITY_PUSH(queue, data)
 Helper macro which allows to PRIORITY push data into a particular queue, checking some conditions, which are logged at the particular position if they fail. More...
 
#define QUEUE_PUSH(queue, data)
 Helper macro which allows to push data into a particular queue, checking some conditions, which are logged at the particular position if they fail. More...
 

Typedefs

typedef struct _MyQttAsyncQueue MyQttAsyncQueue
 Message queue implementation that allows to communicate several threads in a safe manner.
 
typedef __OS_COND_TYPE__ MyQttCond
 Conditional variable mutex, encapsulating the underlaying operating system implementation for conditional variables inside critical sections.
 
typedef struct _MyQttConn MyQttConn
 A MyQtt Connection object. More...
 
typedef struct _MyQttConnOpts MyQttConnOpts
 Connection options.
 
typedef struct _MyQttCtx MyQttCtx
 MyQtt library context. More...
 
typedef struct _MyQttHash MyQttHash
 Thread safe hash used by MyQtt.
 
typedef struct _MyQttMsg MyQttMsg
 A single MQTT received message.
 
typedef __OS_MUTEX_TYPE__ MyQttMutex
 Mutex definition that encapsulates the underlaying mutex API.
 
typedef __OS_THREAD_TYPE__ MyQttThread
 Thread definition, which encapsulates the os thread API, allowing to provide a unified type for all threading interface.
 
typedef axlPointer(* MyQttThreadFunc )(axlPointer user_data)
 Handle definition for the family of function that is able to accept the function myqtt_thread_create. More...
 

Enumerations

enum  MyQttConnAckTypes {
  MYQTT_CONNACK_UNKNOWN_ERR = -4, MYQTT_CONNACK_CONNECT_TIMEOUT = -3, MYQTT_CONNACK_UNABLE_TO_CONNECT = -2, MYQTT_CONNACK_DEFERRED = -1,
  MYQTT_CONNACK_ACCEPTED = 0, MYQTT_CONNACK_REFUSED = 1, MYQTT_CONNACK_IDENTIFIER_REJECTED = 2, MYQTT_CONNACK_SERVER_UNAVAILABLE = 3,
  MYQTT_CONNACK_BAD_USERNAME_OR_PASSWORD = 4, MYQTT_CONNACK_NOT_AUTHORIZED = 5
}
 Set of return codes that are used by the library to reply to CONNECT requests. More...
 
enum  MyQttIoWaitingFor { READ_OPERATIONS = 1 << 0, WRITE_OPERATIONS = 1 << 1 }
 Allows to specify which type of operation should be implemented while calling to MyQtt Library internal IO blocking abstraction. More...
 
enum  MyQttIoWaitingType { MYQTT_IO_WAIT_SELECT = 1, MYQTT_IO_WAIT_POLL = 2, MYQTT_IO_WAIT_EPOLL = 3 }
 Enumeration type that allows to use the waiting mechanism to be used by the core library to perform wait on changes on sockets handled. More...
 
enum  MyQttMsgType {
  MYQTT_CONNECT = 1, MYQTT_CONNACK = 2, MYQTT_PUBLISH = 3, MYQTT_PUBACK = 4,
  MYQTT_PUBREC = 5, MYQTT_PUBREL = 6, MYQTT_PUBCOMP = 7, MYQTT_SUBSCRIBE = 8,
  MYQTT_SUBACK = 9, MYQTT_UNSUBSCRIBE = 10, MYQTT_UNSUBACK = 11, MYQTT_PINGREQ = 12,
  MYQTT_PINGRESP = 13, MYQTT_DISCONNECT = 14
}
 Message type (Control packet types). More...
 
enum  MyQttNetTransport { MYQTT_IPv4 = 1, MYQTT_IPv6 = 2 }
 Definition for supported network transports. More...
 
enum  MyQttPeerRole { MyQttRoleUnknown, MyQttRoleInitiator, MyQttRoleListener, MyQttRoleMasterListener }
 Provides info about the role of the MyQttConn. More...
 
enum  MyQttPublishCodes { MYQTT_PUBLISH_OK = 1, MYQTT_PUBLISH_DISCARD = 2, MYQTT_PUBLISH_CONN_CLOSE = 3, MYQTT_PUBLISH_DUNNO = 4 }
 Return codes used for MyQttOnPublish handler. More...
 
enum  MyQttQos {
  MYQTT_QOS_DENIED = 128, MYQTT_QOS_SKIP_STORAGE = 127, MYQTT_QOS_SKIP_STOREAGE_NOTIFY = 126, MYQTT_QOS_AT_MOST_ONCE = 0,
  MYQTT_QOS_0 = 0, MYQTT_QOS_AT_LEAST_ONCE_DELIVERY = 1, MYQTT_QOS_1 = 1, MYQTT_QOS_EXACTLY_ONCE_DELIVERY = 2,
  MYQTT_QOS_2 = 2
}
 Quality of service for message delivery. More...
 
enum  MyQttStatus {
  MyQttError = 1, MyQttOk = 2, MyQttBindError = 3, MyQttWrongReference = 4,
  MyQttNameResolvFailure = 5, MyQttSocketCreationError = 6, MyQttSocketSanityError = 7, MyQttConnectionError = 8,
  MyQttConnectionTimeoutError = 9, MyQttGreetingsFailure = 10, MyQttXmlValidationError = 11, MyQttConnectionCloseCalled = 12,
  MyQttConnectionForcedClose = 13, MyQttProtocolError = 14, MyQttConnectionFiltered = 15, MyQttMemoryFail = 16,
  MyQttUnnotifiedConnectionClose = 17
}
 MyQtt Operation Status. More...
 
enum  MyQttThreadConf { MYQTT_THREAD_CONF_END = 0, MYQTT_THREAD_CONF_JOINABLE = 1, MYQTT_THREAD_CONF_DETACHED = 2 }
 Thread configuration its to modify default behaviour provided by the thread creation API. More...
 

Detailed Description