Thingstream Client Library  BLD4131-v2.13
Macros | Typedefs | Variables

Mappings from v1.x to v2.x symbols To avoid namespace pollution, they can be disabled at build time by defining THINGSTREAM_NO_SHORT_NAMES. More...

Collaboration diagram for Symbol mappings:

Macros

#define MQTT_QOS0   ThingstreamQOS0
 
#define MQTT_QOS1   ThingstreamQOS1
 
#define MQTT_QOS2   ThingstreamQOS2
 
#define MQTTSN_QOSM1   ThingstreamQOSM1
 
#define Client_create(transport, domainKey)
 
#define Client_destroy   Thingstream_Client_shutdown
 
#define Client_disconnect   Thingstream_Client_disconnect
 
#define Client_isConnected   Thingstream_Client_ping
 
#define Client_register   Thingstream_Client_register
 
#define Client_subscribeName   Thingstream_Client_subscribeName
 
#define Client_subscribeTopic   Thingstream_Client_subscribeTopic
 
#define Client_unsubscribeName   Thingstream_Client_unsubscribeName
 
#define Client_unsubscribeTopic   Thingstream_Client_unsubscribeTopic
 
#define Client_run   Thingstream_Client_run
 
#define Client_getErrorText   Thingstream_Client_getErrorText
 
#define Client_connect(client, clean, callback, cookie)
 
#define Client_publish(client, topic, qos, retained, payload, payloadlen, unused)    Thingstream_Client_publish((client), (topic), (qos), (retained), (payload), (payloadlen))
 
#define Client_ConnectionTimeout   Thingstream_Client_connectionTimeout
 
#define PredefinedSelfTopic   Thingstream_PredefinedSelfTopic
 
#define Register_callback   ThingstreamRegisterCallback_t
 
#define Subscribe_callback   ThingstreamSubscribeCallback_t
 
#define Client_set_subscribe_callback   Thingstream_Client_setSubscribeCallback
 
#define Client_clear_subscribe_callback   Thingstream_Client_clearSubscribeCallback
 
#define Client_set_register_callback   Thingstream_Client_setRegisterCallback
 
#define Client_clear_register_callback   Thingstream_Client_clearRegisterCallback
 

Typedefs

typedef ThingstreamClient Client
 
typedef ThingstreamTopic Topic
 
typedef ThingstreamClientResult ClientResult
 
typedef ThingstreamQualityOfService_t QOS
 

Variables

uint16_t Thingstream_Client_connectionTimeout
 

Detailed Description

Mappings from v1.x to v2.x symbols To avoid namespace pollution, they can be disabled at build time by defining THINGSTREAM_NO_SHORT_NAMES.

Macro Definition Documentation

◆ Client_clear_register_callback

#define Client_clear_register_callback   Thingstream_Client_clearRegisterCallback

◆ Client_clear_subscribe_callback

#define Client_clear_subscribe_callback   Thingstream_Client_clearSubscribeCallback

◆ Client_connect

#define Client_connect (   client,
  clean,
  callback,
  cookie 
)
Value:
( Thingstream_Client_setRegisterCallback((client), (callback), (cookie)), \
Thingstream_Client_connect((client), (clean), Thingstream_Client_connectionTimeout, Thingstream_Client__domainKey) )
Deprecated:
Renamed to Thingstream_Client_connect() with additional parameters to set the timeout (in place of Client_ConnectionTimeout), and to take the domain key (previously passed to Client_create()) The callback and cookie parameters should instead be passed to a separate call to Thingstream_Client_setRegisterCallback().

◆ Client_ConnectionTimeout

#define Client_ConnectionTimeout   Thingstream_Client_connectionTimeout
Deprecated:
This is used by the compatabilty macro Client_connect() but not when Thingstream_Client_connect() is used.

◆ Client_create

#define Client_create (   transport,
  domainKey 
)
Deprecated:
Split into two APIs Thingstream_createClient() and Thingstream_Client_init()
Parameters
transportthe ThingstreamTransport instance
domainKeya unique identifier for the client (use NULL to obtain a value from the transport layer).
Returns
a pointer to a ThingstreamClient instance, or NULL if the client instance cannot be created and initialised.

◆ Client_destroy

#define Client_destroy   Thingstream_Client_shutdown
Deprecated:
Split into two APIs Thingstream_Client_shutdown() and Thingstream_Client_destroy() but since the latter is currently a no-op, this is just mapped to the former.

◆ Client_disconnect

#define Client_disconnect   Thingstream_Client_disconnect

◆ Client_getErrorText

#define Client_getErrorText   Thingstream_Client_getErrorText

◆ Client_isConnected

#define Client_isConnected   Thingstream_Client_ping

◆ Client_publish

#define Client_publish (   client,
  topic,
  qos,
  retained,
  payload,
  payloadlen,
  unused 
)     Thingstream_Client_publish((client), (topic), (qos), (retained), (payload), (payloadlen))
Deprecated:
renamed to Thingstream_Client_publish() without the final parameter

◆ Client_register

#define Client_register   Thingstream_Client_register

◆ Client_run

#define Client_run   Thingstream_Client_run

◆ Client_set_register_callback

#define Client_set_register_callback   Thingstream_Client_setRegisterCallback

◆ Client_set_subscribe_callback

#define Client_set_subscribe_callback   Thingstream_Client_setSubscribeCallback

◆ Client_subscribeName

#define Client_subscribeName   Thingstream_Client_subscribeName

◆ Client_subscribeTopic

#define Client_subscribeTopic   Thingstream_Client_subscribeTopic

◆ Client_unsubscribeName

#define Client_unsubscribeName   Thingstream_Client_unsubscribeName

◆ Client_unsubscribeTopic

#define Client_unsubscribeTopic   Thingstream_Client_unsubscribeTopic

◆ MQTT_QOS0

#define MQTT_QOS0   ThingstreamQOS0

◆ MQTT_QOS1

#define MQTT_QOS1   ThingstreamQOS1

◆ MQTT_QOS2

#define MQTT_QOS2   ThingstreamQOS2

◆ MQTTSN_QOSM1

#define MQTTSN_QOSM1   ThingstreamQOSM1

◆ PredefinedSelfTopic

#define PredefinedSelfTopic   Thingstream_PredefinedSelfTopic

◆ Register_callback

#define Register_callback   ThingstreamRegisterCallback_t

◆ Subscribe_callback

#define Subscribe_callback   ThingstreamSubscribeCallback_t

Typedef Documentation

◆ Client

◆ ClientResult

◆ QOS

◆ Topic

Variable Documentation

◆ Thingstream_Client_connectionTimeout

uint16_t Thingstream_Client_connectionTimeout
extern

The duration (in minutes) that the server will consider the connection active after receiving a message from the client.

Deprecated:
This is used by the compatabilty macro Client_connect() but not when Thingstream_Client_connect() is used.
Thingstream_Client_connectionTimeout
uint16_t Thingstream_Client_connectionTimeout
Definition: connection_timeout.c:33
Thingstream_Client_setRegisterCallback
void Thingstream_Client_setRegisterCallback(ThingstreamClient *client, ThingstreamRegisterCallback_t callback, void *cookie)