sbrcsr 3.2.0
ATOMAS sbrcsr
Library

General (miscellaneous) library API. More...

Functions

SBR_CSR_EXPORT const char * sbr_csr_version (void)
 Return the version of the SBR Core Services Requester API. More...
 
SBR_CSR_EXPORT int sbr_csr_init (ato_Ctx *ctx, unsigned short flag)
 Initialise the SDK. More...
 
SBR_CSR_EXPORT void sbr_csr_deinit (void)
 Deinitialise the SDK. More...
 
SBR_CSR_EXPORT const char * sbr_csr_default_templatefile (void)
 The default filename for the CSR template file. More...
 
SBR_CSR_EXPORT int sbr_csr_loadtemplate (ato_Ctx *ctx, char **buffer, const char *dirname, const char *filename)
 Helper method to load an CSR template from a path. More...
 

Detailed Description

General (miscellaneous) library API.

Function Documentation

◆ sbr_csr_version()

SBR_CSR_EXPORT const char * sbr_csr_version ( void  )

Return the version of the SBR Core Services Requester API.

Returns
version in the form major.minor.patch.tweak (not all levels may be present)

◆ sbr_csr_init()

SBR_CSR_EXPORT int sbr_csr_init ( ato_Ctx ctx,
unsigned short  flag 
)

Initialise the SDK.

This must be called at application startup prior to any threads being started.

ato_base_init() must be called first.

Parameters
ctxthe current thread local Context.
flagused to control the initialisation process - use SBR_CSR_INIT_ALL unless advised otherwise.
Returns
ATO_ERR_OK or an errcode.

◆ sbr_csr_deinit()

SBR_CSR_EXPORT void sbr_csr_deinit ( void  )

Deinitialise the SDK.

This must be called at application shutdown after threads are finished and any allocated objects freed.

ato_base_deinit() should be called after all other deinitialisation routines are called.

◆ sbr_csr_default_templatefile()

SBR_CSR_EXPORT const char * sbr_csr_default_templatefile ( void  )

The default filename for the CSR template file.

Returns
the default CSR template filename.

◆ sbr_csr_loadtemplate()

SBR_CSR_EXPORT int sbr_csr_loadtemplate ( ato_Ctx ctx,
char **  buffer,
const char *  dirname,
const char *  filename 
)

Helper method to load an CSR template from a path.

Parameters
ctxthe current thread local Context.
bufferthe address of the buffer to load the contents into - must be freed by the caller.
dirnamethe directory to use. Cannot be NULL. Can include or be the filename.
filenamethe filename to use. Can be NULL if just using dirname.
Returns
ATO_ERR_OK or an errcode.