Synopsis

typedef struct {
  const char *api_key;
  CTL_XIVELY_FEED_t *feed;
  const CTL_XIVELY_TRANSPORT_t *transport;
  const CTL_XIVELY_DATA_ENCODER_t *data_encoder;
  const CTL_XIVELY_COMMS_t *comms;
  CTL_STRBUF_t strbuf;
} CTL_XIVELY_API_t;

Description

CTL_XIVELY_API_t defines the Xively API context that the library uses to communicate with and present data to the Xively REST API.

Structure

api_key

The API key that's presented to Xively when accessing the Xively REST API.

feed

Private pointer to the feed managed by this API context.

transport

Private pointer to the transport layer implementation. At present, this library only implements an HTTP transport.

data_encoder

Private pointer to the data encoder for datapoints and datastreams.

comms

Private pointer to the communications layer to access the Xively API. At present, only the TCP/IP protocol is implemented using the CrossWorks TCP/IP Library.