atobnet  3.2.0
ATOMAS atobnet
Library

General (miscellaneous) library API. More...

Functions

ATO_BNET_EXPORT const char * ato_bnet_version (void)
 Return the version of the BNET library. More...
 
ATO_BNET_EXPORT bool ato_bnet_isinited (void)
 Returns whether or not the library is initialised. More...
 
ATO_BNET_EXPORT int ato_bnet_init (ato_Ctx *ctx, unsigned short flag)
 Initialise the SDK. More...
 
ATO_BNET_EXPORT void ato_bnet_deinit (void)
 Deinitialise the SDK. More...
 

Detailed Description

General (miscellaneous) library API.

Function Documentation

◆ ato_bnet_version()

ATO_BNET_EXPORT const char* ato_bnet_version ( void  )

Return the version of the BNET library.

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

◆ ato_bnet_isinited()

ATO_BNET_EXPORT bool ato_bnet_isinited ( void  )

Returns whether or not the library is initialised.

Returns
TRUE or FALSE.

◆ ato_bnet_init()

ATO_BNET_EXPORT int ato_bnet_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 ATO_BNET_INIT_ALL unless advised otherwise.
Returns
ATO_ERR_OK

◆ ato_bnet_deinit()

ATO_BNET_EXPORT void ato_bnet_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.