Sternum iOS SDK
sternum_sdk.h
Go to the documentation of this file.
1 
7 #ifndef __STERNUM_SDK_H__
8 #define __STERNUM_SDK_H__
9 
10 #ifdef __cplusplus
11  extern "C" {
12 #endif
13 
14 #include "device_type.h"
15 #include "error_codes.h"
16 #include "sternum_trace_api.h"
17 #include "sternum_settings.h"
18 
19 
20 typedef struct {
24  const char* sternum_url;
28  uint64_t access_token;
32  const char* firmware_version;
48 
58 
60 
69 
84 sternum_code_t sternum_ios_sdk_initialize(const sternum_ios_sdk_settings_t *sdk_options);
85 
106  sternum_code_t sternum_sdk_initialize(const char* sternum_url, const char* firmware_version, bool relay_override_device_id, uint64_t sdk_device_definition_id, bool is_production, size_t max_cache_size);
107 
119  sternum_code_t sternum_sdk_relay_device_data(const device_type_e device_type, const void* data, size_t size);
120 
129  sternum_code_t sternum_sdk_flush(void);
130 
137  void sternum_sdk_close(void);
138 
139 
140 #ifdef __cplusplus
141 }
142 #endif
143 
144 #endif /* __STERNUM_SDK_H__ */
sternum_code_t sternum_sdk_flush(void)
Flush transmission queue.
Definition: sternum_sdk.m:130
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.
Definition: sternum_sdk.m:126
sternum_code_t sternum_ios_sdk_initialize(const sternum_ios_sdk_settings_t *sdk_options)
Initializes the Sternum SDK.
Definition: sternum_sdk.m:70
void init_sternum_ios_settings(sternum_ios_sdk_settings_t *settings)
Initializes the SDK settings structure.
Definition: sternum_sdk.m:62
void sternum_sdk_close(void)
Closes the Sternum SDK. Call initialize to reinitialize.
Definition: sternum_sdk.m:134
sternum_code_t sternum_sdk_initialize(const char *sternum_url, const char *firmware_version, bool relay_override_device_id, uint64_t sdk_device_definition_id, bool is_production, size_t max_cache_size)
Initializes the Sternum SDK (Legacy API).
Definition: sternum_sdk.m:101
Defines the SDK's API for transmitting traces.
Definition: sternum_sdk.h:20
const char * sternum_url
Your Sternum dedicated transmission URL.
Definition: sternum_sdk.h:24
bool is_production
If the application is in production/development phase. The SDK will report this status to the cloud d...
Definition: sternum_sdk.h:37
uint64_t access_token
Device definition id for traces transmitted from the importing application.
Definition: sternum_sdk.h:28
bool relay_override_device_id
if a remote device that originated the relayed traces cannot have a random a device ID,...
Definition: sternum_sdk.h:47
sternum_transmission_callbacks_t transmission_callbacks
Optional callback functions that the SDK can invoke during transmission operation.
Definition: sternum_sdk.h:57
const char * firmware_version
String identifying client's application firmware version.
Definition: sternum_sdk.h:32
size_t max_cache_size_bytes
The maximum amount of bytes to store on disk when caching traces. Cache is automatically emptied when...
Definition: sternum_sdk.h:42
Definition: sternum_transmission_callbacks.h:70