include/umbra.h file

Platform integration utilities.

Enums

enum UmbraLibraryInfo { UmbraLibraryInfo_Version = 0, UmbraLibraryInfo_Copyright, UmbraLibraryInfo_BuildTime, UmbraLibraryInfo_BuildId }

Typedefs

typedef struct UmbraClient UmbraClient
Opaque client object.

Functions

void UmbraConfigInit(UmbraConfig*)
void UmbraSetAllocator(UmbraConfig* config, const UmbraAllocator* allocator)
Replaces the default allocator.
void UmbraSetLogger(UmbraConfig* config, const UmbraLogger* logger, UmbraLogLevel minLevel)
Replaces the default logger.
void UmbraSetHttp(UmbraConfig* config, const UmbraHttp* http)
Replaces the default http implementation.
UmbraClient* UmbraClientCreate(const char* appName, const UmbraConfig* config)
Creates a client object.
void UmbraClientDestroy(UmbraClient* client)
Destroys the client object.
const char* UmbraGetLibraryInfo(UmbraLibraryInfo field)

Enum details

enum UmbraLibraryInfo

Enumerators
UmbraLibraryInfo_Version

version string of the library (format: major.minor.build, "3.1.2")

UmbraLibraryInfo_Copyright

library copyright info string

UmbraLibraryInfo_BuildTime

library build date & time

UmbraLibraryInfo_BuildId

library build ID

Function details

void UmbraSetAllocator(UmbraConfig* config, const UmbraAllocator* allocator)

Replaces the default allocator.

Parameters
config in The configuration whose allocator is replaced.
allocator in The pointer to the allocator implementation.

void UmbraSetLogger(UmbraConfig* config, const UmbraLogger* logger, UmbraLogLevel minLevel)

Replaces the default logger.

Parameters
config in The configuration whose logger is replaced.
logger in The pointer to the logger implementation.
minLevel in The minimum logging level.

void UmbraSetHttp(UmbraConfig* config, const UmbraHttp* http)

Replaces the default http implementation.

Parameters
config in The configuration whose http implementation is replaced.
http in The pointer to the http implementation.

UmbraClient* UmbraClientCreate(const char* appName, const UmbraConfig* config)

Creates a client object.

Parameters
appName in The application name.
config in The pointer to the config object.
Returns The pointer to the client object.

void UmbraClientDestroy(UmbraClient* client)

Destroys the client object.

Parameters
client in The client to destroy.