Sternum Embedded 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 "sternum_sdk/api/sternum_error_codes.h"
15 #include "sternum_sdk/api/sternum_settings.h"
16 #include "sternum_sdk/api/sternum_trace_api.h"
17 
31 sternum_code_t sternum_sdk_initialize(sternum_sdk_settings_t* settings);
32 
46 sternum_code_t sternum_sdk_flush(void);
47 
53 size_t sternum_sdk_cached_traces_count(void);
54 
60 size_t sternum_sdk_cache_space_available(void);
61 
68 void sternum_sdk_close(void);
69 
70 #ifdef __cplusplus
71 }
72 #endif
73 
74 #endif /* __STERNUM_SDK_H__ */
sternum_error_codes.h
Sternum SDK error codes.
sternum_code_t
int sternum_code_t
Definition: sternum_error_codes.h:15
sternum_sdk_flush
sternum_code_t sternum_sdk_flush(void)
Flush transmission queue.
sternum_sdk_initialize
sternum_code_t sternum_sdk_initialize(sternum_sdk_settings_t *settings)
Initializes the Sternum SDK.
sternum_sdk_cache_space_available
size_t sternum_sdk_cache_space_available(void)
Returns available space in packets buffer [bytes].
sternum_sdk_cached_traces_count
size_t sternum_sdk_cached_traces_count(void)
Returns a number of pending traces in cache buffer.
sternum_sdk_close
void sternum_sdk_close(void)
Closes the Sternum SDK.
sternum_settings.h
Provides definition of sternum_sdk_settings_t structure.
sternum_trace_api.h
Sternum trace API.
sternum_sdk_settings_t
Configuration structure for initializing the SDK.
Definition: sternum_settings.h:26