ThingWorx C SDK
Public Attributes | List of all members
twApi Struct Reference

ThingWorx API structure definition. More...

#include <twApi.h>

Public Attributes

twMessageHandlermh
 
twListcallbackList
 
twListboundList
 
twListbindEventCallbackList
 
genericRequest_cb defaultRequestHandler
 
char autoreconnect
 
int8_t manuallyDisconnected
 
char isAuthenticated
 
uint8_t duty_cycle
 
uint32_t duty_cycle_period
 
TW_MUTEX mtx
 
char offlineMsgEnabled
 
twListofflineMsgList
 
uint32_t offlineMsgSize
 
char * offlineMsgFile
 
char * subscribedPropsFile
 
uint32_t subscribedPropsSize
 
uint32_t ping_rate
 
char handle_pongs
 
uint32_t connect_timeout
 
int16_t connect_retries
 
char connectionInProgress
 
char firstConnectionComplete
 
twConnectionInfoconnectionInfo
 

Detailed Description

ThingWorx API structure definition.

Note
A singleton instance of this structure is automatically created when twApi_initialize() is called. There should be no need to manipulate this structure directly.

Member Data Documentation

char twApi::autoreconnect

#TRUE if automatic reconnection to ThingWorx server is enabled.

twList* twApi::bindEventCallbackList

Pointer to a twList of bind event callbacks.

twList* twApi::boundList

Pointer to a twList of bound entities.

twList* twApi::callbackList

Pointer to a twList of callbacks.

int16_t twApi::connect_retries

The number of times to attempt to reconnect if the connection fails.

uint32_t twApi::connect_timeout

How long to wait for the websocket to be established (in milliseconds).

twConnectionInfo* twApi::connectionInfo

twConnectionInfo associated with the API.

char twApi::connectionInProgress

Connection in progress flag.

genericRequest_cb twApi::defaultRequestHandler

The default request handler.

uint8_t twApi::duty_cycle

The duty cycle of the connection in percent (1-100).

uint32_t twApi::duty_cycle_period

The connection period (in milliseconds). Value of 0 indicates AlwaysOn and overrides duty_cycle.

char twApi::firstConnectionComplete

First connection completion flag.

char twApi::handle_pongs

#TRUE if Pongs are currently handled in the API (see twApi_RegisterPongCallback()).

char twApi::isAuthenticated

Authentication status flag.

int8_t twApi::manuallyDisconnected

#TRUE if the API was manually disconnected from the ThingWorx server.

twMessageHandler* twApi::mh

Pointer to the ThingWorx message handler.

TW_MUTEX twApi::mtx

ThingWorx mutex.

char twApi::offlineMsgEnabled

Offline message enabled flag.

char* twApi::offlineMsgFile

The offline message filename.

twList* twApi::offlineMsgList

Pointer to a twList of offline messages.

uint32_t twApi::offlineMsgSize

The size of the offline message(s).

uint32_t twApi::ping_rate

The websockets Ping/Pong interval.

char* twApi::subscribedPropsFile

Subscribed properties file.

uint32_t twApi::subscribedPropsSize

Subscribed properties size.


The documentation for this struct was generated from the following file: