Sternum Android SDK
sternum_sdk.h File Reference

Defines the SDK's C API. More...

#include "device_type.h"
#include "error_codes.h"
#include "sternum_trace_api.h"

Go to the source code of this file.

Functions

sternum_code_t sternum_sdk_initialize (const char *sternum_url, bool relay_override_device_id, uint64_t sdk_device_definition_id, bool is_production, size_t max_cache_size)
 Initializes the Sternum SDK. More...
 
sternum_code_t sternum_sdk_relay_device_data (const device_type_e device_type, const void *data, size_t size)
 transmit relayed data that was received from a remote device. More...
 
sternum_code_t sternum_sdk_flush (void)
 Flush transmission queue. More...
 
void sternum_sdk_close (void)
 Closes the Sternum SDK. Call initialize to reinitialize. More...
 

Detailed Description

Defines the SDK's C API.

Function Documentation

◆ sternum_sdk_close()

void sternum_sdk_close ( void  )

Closes the Sternum SDK. Call initialize to reinitialize.

Note
Call flush before close to prevent data loss
This function blocks until the all resources are released.

◆ sternum_sdk_flush()

sternum_code_t sternum_sdk_flush ( void  )

Flush transmission queue.

Note
This function will block until all pending data is processed and saved to cache.
This function will not ensure a transmission of data to the cloud.
Returns
sternum_code_t

◆ sternum_sdk_initialize()

sternum_code_t sternum_sdk_initialize ( const char *  sternum_url,
bool  relay_override_device_id,
uint64_t  sdk_device_definition_id,
bool  is_production,
size_t  max_cache_size 
)

Initializes the Sternum SDK.

Function is not implemented. Please initialize using the Java API.

◆ sternum_sdk_relay_device_data()

sternum_code_t sternum_sdk_relay_device_data ( const device_type_e  device_type,
const void *  data,
size_t  size 
)

transmit relayed data that was received from a remote device.

Parameters
device_typeeach device type as its own channel for relaying sternum traces. If you are relaying multiple devices in parallel, please make sure to assign each a different device type.
datadata to relay.
sizethe size of the data.
Note
This function does not block.
Returns
sternum_code_t