Thingstream Client Library  BLD4131-v2.13
Enumerations
thingstream_result.h File Reference

The Thingstream Result values from client and transport apis. More...

Enumerations

enum  ThingstreamResult {
  CLIENT_SUCCESS = 0,
  TRANSPORT_SUCCESS = 0 ,
  CLIENT_PUBLISH_TOO_LONG = -3,
  CLIENT_OPERATION_TIMED_OUT = -5,
  CLIENT_DOMAIN_KEY_INVALID = -6,
  CLIENT_CLIENT_ID_INVALID = CLIENT_DOMAIN_KEY_INVALID,
  CLIENT_NOT_CONNECTED = -10,
  CLIENT_FEATURE_NOT_IMPLEMENTED = -11,
  CLIENT_ILLEGAL_ARGUMENT = -12,
  CLIENT_MQTTSN_DECODE_ERROR = -13,
  CLIENT_TOPIC_INVALID = -14,
  CLIENT_CONGESTION = -15,
  CLIENT_WRONG_STATE = -16,
  CLIENT_CONNECT_BAD_ACK = -18,
  CLIENT_REGISTER_BAD_ACK = -19,
  CLIENT_PUBLISH_BAD_ACK = -20,
  CLIENT_SUBSCRIBE_BAD_ACK = -21,
  CLIENT_UNSUBSCRIBE_BAD_ACK = -22,
  CLIENT_INFORMATION_NOT_AVAILABLE = -23,
  CLIENT_UNKNOWN_TRANSPORT_ERROR = -39,
  TRANSPORT_ERROR = -40,
  TRANSPORT_VERSION_MISMATCH = -41,
  TRANSPORT_UNEXPECTED_DATA = -42,
  TRANSPORT_INIT_TIMEOUT = -43,
  TRANSPORT_READ_TIMEOUT = -44,
  TRANSPORT_READ_OVERFLOW = -45,
  TRANSPORT_SEND_TIMEOUT = -46,
  TRANSPORT_ILLEGAL_ARGUMENT = -47,
  TRANSPORT_INTERNAL_ERROR = -48,
  TRANSPORT_ACK_TIMEOUT = -49,
  TRANSPORT_INTERPACKET_ACK_TIMEOUT = -50,
  TRANSPORT_DEFERRED_END_TIMEOUT = -51,
  TRANSPORT_END_TIMEOUT = -52,
  TRANSPORT_INIT_AT_FAILURE = -53,
  TRANSPORT_INIT_CREG5_TIMEOUT = -54,
  TRANSPORT_INIT_CREG_REFUSED = -55,
  TRANSPORT_BUFFER_TOO_SMALL = -56,
  TRANSPORT_INIT_UDP_NETWORK_RESET_FAILED = -57,
  TRANSPORT_INIT_UDP_NETWORK_OPEN_FAILED = -58,
  TRANSPORT_INIT_UDP_NETWORK_ATTACH_FAILED = -59,
  TRANSPORT_INIT_APN_SETUP_FAILED = -60,
  TRANSPORT_INIT_UDP_IP_ADDR_FAILED = -61,
  TRANSPORT_INIT_UDP_CONNECT_FAILED = -62,
  TRANSPORT_INIT_UDP_SOCKET_CREATE_FAILED = -63,
  TRANSPORT_MODEM_ERROR = -64,
  TRANSPORT_MODEM_CME_ERROR = -65,
  TRANSPORT_MODEM_FORCED_RESET = -66,
  TRANSPORT_MODEM_CUSD2_ERROR = -67,
  TRANSPORT_MODEM_CUSD3_ERROR = -68,
  TRANSPORT_MODEM_CUSD4_ERROR = -69,
  TRANSPORT_MODEM_CUSD5_ERROR = -70 ,
  TRANSPORT_MODEM2_WITH_LINE_BUFFER_ERROR = -71,
  TRANSPORT_MODEM_USSD_BASE64_ERROR = -72,
  TRANSPORT_MODEM_SEND_RETRY_REQUEST = -73,
  CLIENT_MAX_ERROR = -127
}
 

Detailed Description

The Thingstream Result values from client and transport apis.

Enumeration Type Documentation

◆ ThingstreamResult

Enumeration of Thingstream result values.

Enumerator
CLIENT_SUCCESS 

The successful client API response

TRANSPORT_SUCCESS 

Transport Operation completed successfully.

CLIENT_PUBLISH_TOO_LONG 

The data supplied to Thingstream_Client_publish() is too long to be transmitted.

CLIENT_OPERATION_TIMED_OUT 

The Thingstream_Client_xxx() API timed out while waiting for the API to complete.

CLIENT_DOMAIN_KEY_INVALID 

The server rejected the domainKey that was passed to Thingstream_Client_connect()

CLIENT_CLIENT_ID_INVALID 
Deprecated:
renamed to CLIENT_DOMAIN_KEY_INVALID
CLIENT_NOT_CONNECTED 

The client API could not be completed as the client is not connected.
The application should call Thingstream_Client_connect() to establish a connection with the server.

CLIENT_FEATURE_NOT_IMPLEMENTED 

A feature is not implemented in this version of the SDK

CLIENT_ILLEGAL_ARGUMENT 

The client API was supplied with an illegal argument

CLIENT_MQTTSN_DECODE_ERROR 

The MQTTSN packet received from the server could not be decoded

CLIENT_TOPIC_INVALID 

The server reports that the topic was invalid (e.g. contains illegal characters or no predefined topic with that alias was found).

CLIENT_CONGESTION 

The server reports severe congestion and requests a later retry

CLIENT_WRONG_STATE 

The SDK state machine received responses that do not match with expected state transitions.

CLIENT_CONNECT_BAD_ACK 

Thingstream_Client_connect() received an unexpected response when waiting for acknowledgment.

CLIENT_REGISTER_BAD_ACK 

Thingstream_Client_register() received an unexpected response when waiting for acknowledgment.

CLIENT_PUBLISH_BAD_ACK 

Thingstream_Client_publish() received an unexpected response when waiting for acknowledgment.

CLIENT_SUBSCRIBE_BAD_ACK 

Thingstream_Client_subscribeName() or Thingstream_Client_subscribeTopic() received an unexpected response when waiting for acknowledgment.

CLIENT_UNSUBSCRIBE_BAD_ACK 

Thingstream_Client_unsubscribeName() or Thingstream_Client_unsubscribeTopic() received an unexpected response when waiting for acknowledgment.

CLIENT_INFORMATION_NOT_AVAILABLE 

The information requested is not available

CLIENT_UNKNOWN_TRANSPORT_ERROR 

An out-of-range result value was returned by a transport api

TRANSPORT_ERROR 

Transport Operation failed with an unspecified error.

TRANSPORT_VERSION_MISMATCH 

Transport initialized with wrong version.

TRANSPORT_UNEXPECTED_DATA 

Transport encountered unexpected data.

TRANSPORT_INIT_TIMEOUT 

Transport Read operation timed out.

TRANSPORT_READ_TIMEOUT 

Transport Read operation timed out.

TRANSPORT_READ_OVERFLOW 

Transport Read operation overflowed the available buffer.

TRANSPORT_SEND_TIMEOUT 

Transport Send operation timed out.

TRANSPORT_ILLEGAL_ARGUMENT 

Transport Illegal argument or parameter

TRANSPORT_INTERNAL_ERROR 

Transport Internal protocol error

TRANSPORT_ACK_TIMEOUT 

Transport Send operation timed out waiting for ACK.

TRANSPORT_INTERPACKET_ACK_TIMEOUT 

Transport Send operation timed out waiting for ACK between packets

TRANSPORT_DEFERRED_END_TIMEOUT 

Transport Send operation timed out waiting for END which had been deferred from a previous ->send() operation.

TRANSPORT_END_TIMEOUT 

Transport Send operation timed out waiting for END

TRANSPORT_INIT_AT_FAILURE 

Transport modem->init() timed out waiting for OK after initial AT command

TRANSPORT_INIT_CREG5_TIMEOUT 

Transport modem->init() timed out waiting for +CREG:5

TRANSPORT_INIT_CREG_REFUSED 

Transport modem->init() registration refused

TRANSPORT_BUFFER_TOO_SMALL 

Transport buffer too small

TRANSPORT_INIT_UDP_NETWORK_RESET_FAILED 

Transport modem->init() unable to reset UDP network stack

TRANSPORT_INIT_UDP_NETWORK_OPEN_FAILED 

Transport modem->init() unable to open the UDP network stack

TRANSPORT_INIT_UDP_NETWORK_ATTACH_FAILED 

Transport modem->init() unable to attach UDP context to network stack

TRANSPORT_INIT_APN_SETUP_FAILED 

Transport modem->init() unable to set the required APN in the modem

TRANSPORT_INIT_UDP_IP_ADDR_FAILED 

Transport modem->init() unable to obtain local IP address

TRANSPORT_INIT_UDP_CONNECT_FAILED 

Transport modem->init() unable to open UDP connection to the server

TRANSPORT_INIT_UDP_SOCKET_CREATE_FAILED 

Transport modem->init() unable to create a UDP socket

TRANSPORT_MODEM_ERROR 

Transport Modem operation failed with an unspecified error.

TRANSPORT_MODEM_CME_ERROR 

Transport Modem operation failed with an unspecified CME error.

TRANSPORT_MODEM_FORCED_RESET 

Transport Modem operation failed and the modem driver forced a soft reset.

TRANSPORT_MODEM_CUSD2_ERROR 

Transport Modem operation failed with an +CUSD:2 error.

TRANSPORT_MODEM_CUSD3_ERROR 

Transport Modem operation failed with an +CUSD:3 error.

TRANSPORT_MODEM_CUSD4_ERROR 

Transport Modem operation failed with an +CUSD:4 error.

TRANSPORT_MODEM_CUSD5_ERROR 

Transport Modem operation failed with an +CUSD:5 error.

TRANSPORT_MODEM2_WITH_LINE_BUFFER_ERROR 

Transport Modem2 used with line (not ring) buffer transport.

TRANSPORT_MODEM_USSD_BASE64_ERROR 

Transport Modem ussd requires base64 in the transport stack.

TRANSPORT_MODEM_SEND_RETRY_REQUEST 

Transport Modem has rejected the send request and no data was sent.

CLIENT_MAX_ERROR 

All error values from Thingstream_Client_xxx() APIs will be greater than CLIENT_MAX_ERROR and less than CLIENT_SUCCESS