quarklink_context_t Struct Reference

Quarklink context. More...

#include <quarklink.h>

Data Fields
char	rootCert [QUARKLINK_MAX_SHORT_CERT_LENGTH]
	Root certificate of the QuarkLink instance.
char *	tempCert
	Temporary certificate obtained from QuarkLink, needed to establish mTLS.
char	endpoint [QUARKLINK_MAX_ENDPOINT_LENGTH]
	QuarkLink instance endpoint.
uint16_t	port
	QuarkLink instance port.
char	deviceID [QUARKLINK_MAX_DEVICE_ID_LENGTH]
	Unique Device ID, initialised by quarklink_init()
char	deviceCert [QUARKLINK_MAX_LONG_CERT_LENGTH]
	Device certificate, obtained when enrolling with QuarkLink via quarklink_enrol()
char	token [QUARKLINK_MAX_TOKEN_LENGTH]
	DBS token, obtained when enrolling with QuarkLink Database Direct.
char	uri [QUARKLINK_MAX_URI_LENGTH]
	DBS URI, obtained when enrolling with QuarkLink Database Direct.
char	database [QUARKLINK_MAX_SHORT_DATA_LENGTH]
	DBS Database, obtained when enrolling with QuarkLink Database Direct.
char	dataSource [QUARKLINK_MAX_SHORT_DATA_LENGTH]
	DBS DataSource, obtained when enrolling with QuarkLink Database Direct.
char	iotHubRootCert [QUARKLINK_MAX_LONG_CERT_LENGTH]
	IoT Hub root certificate, obtained after enrolling with QuarkLink.
char	iotHubEndpoint [QUARKLINK_MAX_ENDPOINT_LENGTH]
	IoT Hub endpoint, obtained after enrolling with Quarklink.
uint16_t	iotHubPort
	IoT Hub port, obtained after enrolling with Quarklink.
char *	scopeID
	Scope ID, only applicable when using Azure Device Provisioning Service.
char *	fwUpdateTopic
	Topic to subscribe to in order to receive firmware update notifications.

Detailed Description

Quarklink context.

This struct is ~6.4KB and contains all the resources needed by a user that wants to use Quarklink. All certificates are in PEM format.

Note

User needs to define a quarklink_context_t variable and initialise it by calling quarklink_init. Calls to QuarkLink APIs populate the struct fields, which the user is free to access. Empty fields are set to zero/NULL. After quarklink_init, the available fields are: rootCert, endpoint, port, deviceID After quarklink_enrol, the additional available fields are: deviceCert, iotHubRootCert, iotHubEndpoint, iotHubPort