Header: gsl/dls_client_api/gsl_dls_client_intf.h
Structures
gsl_dls_ready_buffer_index_list_t
Members
gsl_dls_buffer_pool_config_t
Members
gls_dls_buffer_t
Members
Functions
gsl_dls_client_is_feature_supported
Checks if the DLS feature is enabled in GSL \detdesc feature needs to be enabled by defining ATS_DATA_LOGGING in your build configuration.
Returns
AR_EOK on success, AR_EUNSUPPORTED otherwise
gsl_dls_client_init
Initializes the DLS Client.
Parameters
struct gsl_dls_buffer_pool_config_t *
configuration used to setup the dls buffer pool size.
GSL_DLS_CLIENT_BUFFER_READY_CALLBACK
callback function that is called when SPF notifies the DLS client about buffers that are ready to read.
gsl_dls_client_deinit
Cleans up resources aquired during gsl_dls_client_init(âŠ)
Returns
AR_EOK on success, error otherwise
gsl_dls_client_create_buffer_pool
Allocates and configures shared memory for storing log buffers and registers for log buffer commit notifications from DLS on SPF.
Parameters
struct gsl_dls_buffer_pool_config_t *
contains the number of DLS Log Buffers and the size of each buffer
gsl_dls_client_get_ready_dls_buffer_list
Retrieves a list of buffers index for dls buffers that are ready to read from.
Parameters
struct gsl_dls_ready_buffer_index_list_t *
gsl_dls_client_get_log_buffer
Gets a log buffer from the dls buffer pool.
Parameters
the index of the buffer to read from the dls buffer pool
struct gls_dls_buffer_t *
contains the size of the log buffer and a pointer to the buffer in the shared memory buffer pool
gsl_dls_client_set_used_buffers
Stores used log buffers in gsl dsl client context.
Parameters
struct gsl_dls_ready_buffer_index_list_t *
list of buffers to be stored
gsl_dls_client_return_used_buffers
Returns used DLS buffers back to SPF.
Parameters
struct gsl_dls_ready_buffer_index_list_t *
the list of buffers to return to DLS on SPF
gsl_dls_client_register_deregister_log_code
Registers or deregisters a log code.
Registered log codes will start to accumulate binary buffers in SPFs DLS
Parameters
The log code to register/de-register
for registering a log code and false for de-registering
Type Definitions
GSL_DLS_CLIENT_BUFFER_READY_CALLBACK
callback function that is called when SPF notifies the DLS client about buffers that are ready to read.
Macros
GSL_DLS_CLIENT_MIN_BUFFER_COUNT
GSL_DLS_CLIENT_MAX_BUFFER_COUNT
