Sternum Linux SDK
sternum_settings.h
Go to the documentation of this file.
1 
7 #ifndef __STERNUM_SETTINGS_H__
8 #define __STERNUM_SETTINGS_H__
9 
10 #ifdef __cplusplus
11  extern "C" {
12 #endif
13 
14 #include <stdint.h>
15 #include <stddef.h>
16 #include <stdbool.h>
17 
19 
20 
27 typedef struct {
28 
32  const char* sternum_url;
33 
37  uint64_t access_token;
38 
42  uint64_t device_id;
43 
47  const char* firmware_version;
48 
53  const uint64_t *relay_override_device_id;
54 
60 
79  const char* cache_file_path;
80 
86 
94 
104 
106 
107 
121 
122 
123 #ifdef __cplusplus
124 }
125 #endif
126 
127 #endif /* __STERNUM_SETTINGS_H__ */
void init_sternum_settings(sternum_settings_t *settings)
Default-initialize settings structure for the SDK.
Defines the SDK's transmission callbacks available for user implementation.
Configuration structure for initializing the SDK.
Definition: sternum_settings.h:27
const char * cache_file_path
Path of the trace file cache.
Definition: sternum_settings.h:79
uint64_t access_token
Device definition id for traces transmitted from the importing application.
Definition: sternum_settings.h:37
const char * firmware_version
String identifying client's application firmware version.
Definition: sternum_settings.h:47
uint64_t device_id
Device id for traces transmitted from the importing application.
Definition: sternum_settings.h:42
bool force_sync_cache
When set to true, the cache file is synchronized to disk after every write, improving resilience agai...
Definition: sternum_settings.h:93
const uint64_t * relay_override_device_id
If a remote device that originated the relayed traces cannot have a random a device ID,...
Definition: sternum_settings.h:53
const char * sternum_url
Your Sternum dedicated transmission URL.
Definition: sternum_settings.h:32
size_t max_cache_size_bytes
The maximum amount of bytes to store on disk when caching traces.
Definition: sternum_settings.h:85
bool is_production
If the application is in production/development phase.
Definition: sternum_settings.h:59
sternum_transmission_callbacks_t transmission_callbacks
Optional callback functions that the SDK can invoke during transmission operation.
Definition: sternum_settings.h:103
Struct to hold the transmission callbacks.
Definition: sternum_transmission_callbacks.h:70