David Fletcher / Mbed 2 deprecated cc3100_Test_mqtt_CM3

Update revision to use TI's mqtt and Freertos.

Dependencies:   mbed client server

Fork of cc3100_Test_mqtt_CM3 by David Fletcher

Embed: (wiki syntax)

« Back to documentation index

SL MQTT Client API
Data Structures | Modules | Functions

SL MQTT Client API

Data Structures

struct  SlMqttClientCbs_t
 Callbacks Routines The routines are invoked by SL Implementation onto Client application. More...
struct  SlMqttServer_t
 Secure Socket Parameters to open a secure connection. More...
struct  SlMqttClientLibCfg_t
 MQTT Lib structure which holds Initialization Data. More...
struct  SlMqttClientCtxCfg_t
 MQTT client context configuration structure. More...

Modules

 SL MQTT Client Events
 SL MQTT Oper Paramters

Functions

int32_t sl_ExtLib_MqttClientInit (const SlMqttClientLibCfg_t *cfg)
 Initialize the SL MQTT Implementation.
int32_t sl_ExtLib_MqttClientExit ()
 Exit the SL MQTT Implementation.
void * sl_ExtLib_MqttClientCtxCreate (const SlMqttClientCtxCfg_t *ctx_cfg, const SlMqttClientCbs_t *msg_cbs, void *app_hndl)
 Create a new client context to connect to a server.
int32_t sl_ExtLib_MqttClientCtxDelete (void *cli_ctx)
 Deletes the specified client context.
int32_t sl_ExtLib_MqttClientSet (void *cli_ctx, int32_t param, const void *value, uint32_t len)
 Set parameters in SL MQTT implementation.
int32_t sl_ExtLib_MqttClientConnect (void *cli_ctx, bool clean, uint16_t keep_alive_time)
 CONNECT to the server.
int32_t sl_ExtLib_MqttClientDisconnect (void *cli_ctx)
 DISCONNECT from the server.
int32_t sl_ExtLib_MqttClientSub (void *cli_ctx, char *const *topics, uint8_t *qos, int32_t count)
 SUBSCRIBE a set of topics.
int32_t sl_ExtLib_MqttClientUnsub (void *cli_ctx, char *const *topics, int32_t count)
 UNSUBSCRIBE a set of topics.
int32_t sl_ExtLib_MqttClientSend (void *cli_ctx, const char *topic, const void *data, int32_t len, char qos, bool retain)
 PUBLISH a named message to the server.
static int32_t sl_ExtLib_MqttClientPub (void *cli_ctx, const char *topic, const void *data, int32_t len, char qos, bool retain)
 PUBLISH a named message to the server - wrapper function.

Function Documentation

int32_t sl_ExtLib_MqttClientConnect ( void *  cli_ctx,
bool  clean,
uint16_t  keep_alive_time 
)

CONNECT to the server.

This routine establishes a connection with the server for MQTT transactions. The caller should specify a time-period with-in which the implementation should send a message to the server to keep-alive the connection.

Parameters:
[in]cli_ctxrefers to the handle to the client context
[in]cleanassert to make a clean start and purge the previous session
[in]keep_alive_timethe maximum time within which client should send a message to server. The unit of the interval is in seconds.
Returns:
on success, variable header of CONNACK message in network byte order. Lowest Byte[Byte0] contains CONNACK Return Code. Byte1 Contains Session Present Bit. on failure returns(-1)

Definition at line 542 of file sl_mqtt_client.cpp.

void * sl_ExtLib_MqttClientCtxCreate ( const SlMqttClientCtxCfg_t *  ctx_cfg,
const SlMqttClientCbs_t *  msg_cbs,
void *  app_hndl 
)

Create a new client context to connect to a server.

A context has to be created prior to invoking the client services.

Parameters:
[in]ctx_cfgrefers to client context configuration parameters
[in]msg_cbsrefers to callbacks into application
[in]apprefers to the application callback to be returned on callback

Definition at line 296 of file sl_mqtt_client.cpp.

int32_t sl_ExtLib_MqttClientCtxDelete ( void *  cli_ctx )

Deletes the specified client context.

Parameters:
[in]cli_ctxrefers to client context to be deleted
Returns:
Success (0) or Failure (< 0)

Definition at line 383 of file sl_mqtt_client.cpp.

int32_t sl_ExtLib_MqttClientDisconnect ( void *  cli_ctx )

DISCONNECT from the server.

The caller must use this service to close the connection with the server.

Parameters:
[in]cli_ctxrefers to the handle to the client context
Returns:
Success (0) or Failure (< 0)

Definition at line 624 of file sl_mqtt_client.cpp.

int32_t sl_ExtLib_MqttClientExit (  )

Exit the SL MQTT Implementation.

Returns:
Success (0) or Failure (-1)

Definition at line 469 of file sl_mqtt_client.cpp.

int32_t sl_ExtLib_MqttClientInit ( const SlMqttClientLibCfg_t *  cfg )

Initialize the SL MQTT Implementation.

A caller must initialize the MQTT implementation prior to using its services.

Parameters:
[in]cfgrefers to client lib configuration parameters
Returns:
Success (0) or Failure (-1)

Definition at line 414 of file sl_mqtt_client.cpp.

static int32_t mbed_mqtt::sl_ExtLib_MqttClientPub ( void *  cli_ctx,
const char *  topic,
const void *  data,
int32_t  len,
char  qos,
bool  retain 
) [static]

PUBLISH a named message to the server - wrapper function.

Definition at line 438 of file sl_mqtt_client.h.

int32_t sl_ExtLib_MqttClientSend ( void *  cli_ctx,
const char *  topic,
const void *  data,
int32_t  len,
char  qos,
bool  retain 
)

PUBLISH a named message to the server.

In addition to the PUBLISH specific parameters, the caller can indicate whether the routine should block until the time, the message has been acknowleged by the server. This is applicable only for non-QoS0 messages.

In case, the app has chosen not to await for the ACK from the server, the SL MQTT implementation will notify the app about the subscription through the callback routine.

Parameters:
[in]cli_ctxrefers to the handle to the client context
[in]topictopic of the data to be published. It is NULL terminated.
[in]databinary data to be published
[in]lenlength of the data
[in]qosQoS for the publish message
[in]retainassert if server should retain the message
[in]flagsCommand flag. Refer to sl_mqtt_cl_cmdflags
Returns:
Success(transaction Message ID) or Failure(< 0)

Definition at line 743 of file sl_mqtt_client.cpp.

int32_t sl_ExtLib_MqttClientSet ( void *  cli_ctx,
int32_t  param,
const void *  value,
uint32_t  len 
)

Set parameters in SL MQTT implementation.

The caller must configure these paramters prior to invoking any MQTT transaction.

Note:
The implementation does not copy the contents referred. Therefore, the caller must ensure that contents are persistent in the memory.
Parameters:
[in]cli_ctxrefers to the handle to the client context
[in]paramidentifies parameter to set. Refer to SL MQTT Oper Paramters
[in]valuerefers to the place-holder of value to be set
[in]lenlength of the value of the parameter
Returns:
Success (0) or Failure (-1)

Definition at line 505 of file sl_mqtt_client.cpp.

int32_t sl_ExtLib_MqttClientSub ( void *  cli_ctx,
char *const *  topics,
uint8_t *  qos,
int32_t  count 
)

SUBSCRIBE a set of topics.

To receive data about a set of topics from the server, the app through this routine must subscribe to those topic names with the server. The caller can indicate whether the routine should block until a time, the message has been acknowledged by the server.

In case, the app has chosen not to await for the ACK from the server, the SL MQTT implementation will notify the app about the subscription through the callback routine.

Parameters:
[in]cli_ctxrefers to the handle to the client context
[in]topicsset of topic names to subscribe. It is an array of pointers to NUL terminated strings.
[in,out]qosarray of qos values for each topic in the same order of the topic array. If configured to await for SUB-ACK from server, the array will contain qos responses for topics from the server.
[in]countnumber of such topics
Returns:
Success(transaction Message ID) or Failure(< 0)

Definition at line 651 of file sl_mqtt_client.cpp.

int32_t sl_ExtLib_MqttClientUnsub ( void *  cli_ctx,
char *const *  topics,
int32_t  count 
)

UNSUBSCRIBE a set of topics.

The app should use this service to stop receiving data for the named topics from the server. The caller can indicate whether the routine should block until a time, the message has been acknowleged by the server.

In case, the app has chosen not to await for the ACK from the server, the SL MQTT implementation will notify the app about the subscription through the callback routine.

Parameters:
[in]cli_ctxrefers to the handle to the client context
[in]topicsset of topics to be unsubscribed. It is an array of pointers to NUL terminated strings.
[in]countnumber of topics to be unsubscribed
Returns:
Success(transaction Message ID) or Failure(< 0)

Definition at line 701 of file sl_mqtt_client.cpp.

Generated on Tue Jul 12 2022 18:55:11 by  doxygen 1.7.2