Thingstream Client Library  BLD4131-v2.13
Modules | Macros | Typedefs | Functions
Backwards Compatibility

An optional set of mappings to allow 1.x clients to build without source-level changes.
. More...

Collaboration diagram for Backwards Compatibility:

Modules

 Symbol mappings
 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.
 
 Application Callback Backwards Compatibility
 APIs to set/clear callbacks that will be called when the server sends the Client messages or topic name to id mappings.
 
 Modem Callback Backwards Compatibility
 APIs to set/clear callbacks that will be called when the modem transport layer receives unexpected responses from the modem.
 

Macros

#define PredefinedSelfTopic   Thingstream_PredefinedSelfTopic
 
#define Platform_getTimeMillis   Thingstream_Platform_getTimeMillis
 
#define Platform_getTimeString   Thingstream_Platform_getTimeString
 
#define log_thingstream_transport_create   Thingstream_createProtocolLogger
 
#define log_modem_transport_create   Thingstream_createModemLogger
 
#define thingstream_transport_create   Thingstream_createProtocolTransport
 
#define thingstream_transport_set_ussd_session_delay   Thingstream_Protocol_setUssdSessionDelay
 
#define modem_transport_create   Thingstream_createModemUssdTransport
 
#define Modem_send_line   Thingstream_ModemUssd_sendLine
 
#define ModemInitString   Thingstream_Modem_initString
 
#define ModemInformationString   Thingstream_Modem_informationString
 
#define ModemUssdEndSessionString   Thingstream_Modem_ussdEndSessionString
 
#define ModemForceResetString   Thingstream_Modem_forceResetString
 
#define Modem_callback   ThingstreamModemCallback_t
 
#define Modem_set_modem_callback   Thingstream_ModemUssd_setCallback
 
#define Modem_clear_modem_callback   Thingstream_ModemUssd_clearCallback
 
#define Modem2_set_modem_callback   Thingstream_Modem2_setCallback
 
#define Modem2_clear_modem_callback   Thingstream_Modem2_clearCallback
 
#define Modem_get_CUSD_errors   Thingstream_ModemUssd_getCUSDErrors
 
#define Modem_get_serious_errors   Thingstream_ModemUssd_getSeriousErrors
 
#define base64_codec_create   Thingstream_createBase64CodecTransport
 
#define log_client_transport_create   Thingstream_createClientLogger
 
#define line_buffer_transport_create   Thingstream__createLegacyLineBufferTransport
 
#define modem2_transport_create   Thingstream_createModem2Transport
 
#define Modem2_send_line   Thingstream_Modem2_sendLine
 
#define Modem2_get_CUSD_errors   Thingstream_Modem2_getCUSDErrors
 
#define Modem2_get_serious_errors   Thingstream_Modem2_getSeriousErrors
 
#define custom_modem_transport_create   Thingstream_createCustomModemTransport
 

Typedefs

typedef ThingstreamTransport Transport
 
typedef ThingstreamPrintf_t transport_logger
 
typedef ThingstreamTransportResult TransportResult
 
typedef ThingstreamTransportCallback_t Transport_callback
 
typedef ThingstreamTransportState_t TransportState
 

Functions

ThingstreamTransportThingstream__createLegacyLineBufferTransport (ThingstreamTransport *inner, uint8_t *data, uint16_t dataSize)
 

Detailed Description

An optional set of mappings to allow 1.x clients to build without source-level changes.
.

Macro Definition Documentation

◆ base64_codec_create

#define base64_codec_create   Thingstream_createBase64CodecTransport

◆ custom_modem_transport_create

#define custom_modem_transport_create   Thingstream_createCustomModemTransport

◆ line_buffer_transport_create

#define line_buffer_transport_create   Thingstream__createLegacyLineBufferTransport
Deprecated:
renamed to Thingstream_createLineBufferTransport() with an extra argument

◆ log_client_transport_create

#define log_client_transport_create   Thingstream_createClientLogger

◆ log_modem_transport_create

#define log_modem_transport_create   Thingstream_createModemLogger

◆ log_thingstream_transport_create

#define log_thingstream_transport_create   Thingstream_createProtocolLogger
Deprecated:
renamed to Thingstream_createProtocolLogger()

◆ Modem2_clear_modem_callback

#define Modem2_clear_modem_callback   Thingstream_Modem2_clearCallback

◆ Modem2_get_CUSD_errors

#define Modem2_get_CUSD_errors   Thingstream_Modem2_getCUSDErrors

◆ Modem2_get_serious_errors

#define Modem2_get_serious_errors   Thingstream_Modem2_getSeriousErrors

◆ Modem2_send_line

#define Modem2_send_line   Thingstream_Modem2_sendLine

◆ Modem2_set_modem_callback

#define Modem2_set_modem_callback   Thingstream_Modem2_setCallback

◆ modem2_transport_create

#define modem2_transport_create   Thingstream_createModem2Transport

◆ Modem_callback

#define Modem_callback   ThingstreamModemCallback_t

◆ Modem_clear_modem_callback

#define Modem_clear_modem_callback   Thingstream_ModemUssd_clearCallback

◆ Modem_get_CUSD_errors

#define Modem_get_CUSD_errors   Thingstream_ModemUssd_getCUSDErrors

◆ Modem_get_serious_errors

#define Modem_get_serious_errors   Thingstream_ModemUssd_getSeriousErrors

◆ Modem_send_line

#define Modem_send_line   Thingstream_ModemUssd_sendLine

◆ Modem_set_modem_callback

#define Modem_set_modem_callback   Thingstream_ModemUssd_setCallback

◆ modem_transport_create

#define modem_transport_create   Thingstream_createModemUssdTransport

◆ ModemForceResetString

#define ModemForceResetString   Thingstream_Modem_forceResetString

◆ ModemInformationString

#define ModemInformationString   Thingstream_Modem_informationString

◆ ModemInitString

#define ModemInitString   Thingstream_Modem_initString

◆ ModemUssdEndSessionString

#define ModemUssdEndSessionString   Thingstream_Modem_ussdEndSessionString

◆ Platform_getTimeMillis

#define Platform_getTimeMillis   Thingstream_Platform_getTimeMillis

◆ Platform_getTimeString

#define Platform_getTimeString   Thingstream_Platform_getTimeString

◆ PredefinedSelfTopic

#define PredefinedSelfTopic   Thingstream_PredefinedSelfTopic

◆ thingstream_transport_create

#define thingstream_transport_create   Thingstream_createProtocolTransport

◆ thingstream_transport_set_ussd_session_delay

#define thingstream_transport_set_ussd_session_delay   Thingstream_Protocol_setUssdSessionDelay

Typedef Documentation

◆ Transport

◆ Transport_callback

◆ transport_logger

◆ TransportResult

◆ TransportState

Function Documentation

◆ Thingstream__createLegacyLineBufferTransport()

ThingstreamTransport* Thingstream__createLegacyLineBufferTransport ( ThingstreamTransport inner,
uint8_t *  data,
uint16_t  dataSize 
)
Deprecated:
prefer Thingstream_createLineBufferTransport()

Legacy helper for line_buffer_transport_create() This api can be called multiple times to return different instances.

Use of the legacy interface uses more text/data/bss than using the preferred Thingstream_createLineBufferTransport() since the legacy api includes all possible instances into the application.

Parameters
innerthe inner ThingstreamTransport instance to use
dataan area of data to use for the buffers
dataSizethe size of the data area
Returns
an instance of the line buffer transport