Synesis Software STLSoft - ... Robust, Lightweight, Cross-platform, Template Software ...

Pantheios UNIX SysLog Stock Back-end
[Pantheios Stock Back-ends]


Detailed Description

Back-end library built on top of the UNIX syslog API.


Modules

 Pantheios UNIX syslog Stock Back-end Flags
 Flags for the Pantheios UNIX SysLog Stock Back-end.

Classes

struct  pan_be_syslog_init_t
 Structure used for specifying initialisation information to the be.syslog library. More...

Functions

void pantheios_be_syslog_getAppInit (int backEndId, pan_be_syslog_init_t *init)
 Callback function defined by the application, invoked when the API is initialised with a NULL init parameter.
void pantheios_be_syslog_getDefaultAppInit (pan_be_syslog_init_t *init)
 Fills out a copy of the initialisation structure with default values (representative of the default behaviour of the library), ready to be customised and passed to the API initialiser function pantheios_be_syslog_init().
int pantheios_be_syslog_init (PAN_CHAR_T const *processIdentity, int id, pan_be_syslog_init_t const *init, void *reserved, void **ptoken)
 Implements the functionality for pantheios_be_init() over the UNIX SysLog API.
void pantheios_be_syslog_uninit (void *token)
 Implements the functionality for pantheios_be_uninit() over the UNIX SysLog API.
int pantheios_be_syslog_logEntry (void *feToken, void *beToken, int severity, PAN_CHAR_T const *entry, size_t cchEntry)
 Implements the functionality for pantheios_be_logEntry() over the UNIX SysLog API.


Function Documentation

void pantheios_be_syslog_getAppInit ( int  backEndId,
pan_be_syslog_init_t init 
)

Callback function defined by the application, invoked when the API is initialised with a NULL init parameter.

Note:
This function is only required when the callback version of the library is used.

void pantheios_be_syslog_getDefaultAppInit ( pan_be_syslog_init_t init  ) 

Fills out a copy of the initialisation structure with default values (representative of the default behaviour of the library), ready to be customised and passed to the API initialiser function pantheios_be_syslog_init().

Note:
This function should not be called on an already-initialised instance, as is the case in the implementation of the pantheios_be_syslog_getAppInit() function, as it will already have been called by pantheios_be_syslog_init() prior to the callback.

int pantheios_be_syslog_init ( PAN_CHAR_T const *  processIdentity,
int  id,
pan_be_syslog_init_t const *  init,
void *  reserved,
void **  ptoken 
)

Implements the functionality for pantheios_be_init() over the UNIX SysLog API.

int pantheios_be_syslog_logEntry ( void *  feToken,
void *  beToken,
int  severity,
PAN_CHAR_T const *  entry,
size_t  cchEntry 
)

Implements the functionality for pantheios_be_logEntry() over the UNIX SysLog API.

void pantheios_be_syslog_uninit ( void *  token  ) 

Implements the functionality for pantheios_be_uninit() over the UNIX SysLog API.


pantheios Library documentation Matthew Wilson & Synesis Software, 2006-2011 SourceForge.net Logo