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

pantheios/backends/bec.WindowsSyslog.h File Reference


Detailed Description

[C, C++] Pantheios Windows-SysLog Back-end Common API

#include <pantheios/pantheios.h>
#include <pantheios/backend.h>

Go to the source code of this file.

Classes

struct  pan_be_WindowsSyslog_init_t
 Structure used for specifying initialisation information to the be.WindowsSyslog library. More...

Defines

#define PANTHEIOS_BE_WINDOWSSYSLOG_F_USE_SYSTEM_TIME   PANTHEIOS_BE_INIT_F_USE_SYSTEM_TIME
 Causes the Pantheios Windows-SysLog Stock Back-end to use system time, rather than local time, from emitted log statements.
#define PANTHEIOS_BE_WINDOWSSYSLOG_F_PERROR   (0x00100000)
 Causes the Pantheios Windows-SysLog Stock Back-end to write to the calling process' standard error, in addition to submitting it to SysLog.
#define PANTHEIOS_BE_WINDOWSSYSLOG_F_CONS   (0x00200000)
 Causes the Pantheios Windows-SysLog Stock Back-end to write any message that fails to be submitted to SysLog to the system console.
#define PANTHEIOS_BE_WINDOWSSYSLOG_F_PID   (0x00400000)
 Causes the Pantheios Windows-SysLog Stock Back-end to include the process Id in the statement.
#define PANTHEIOS_BE_WINDOWSSYSLOG_F_NDELAY   (0x00800000)
 Causes the Pantheios Windows-SysLog Stock Back-end to connect to the syslog socket immediately, rather than on the first call to syslog().
#define PANTHEIOS_SYSLOG_FAC_KERN   (0)
 Kernel messages.
#define PANTHEIOS_SYSLOG_FAC_USER   (1)
 Arbitrary user-level messages (the default).
#define PANTHEIOS_SYSLOG_FAC_MAIL   (2)
 Mail system messages.
#define PANTHEIOS_SYSLOG_FAC_DAEMON   (3)
 System daemon messages.
#define PANTHEIOS_SYSLOG_FAC_AUTH   (4)
 Security / authorisation messages.
#define PANTHEIOS_SYSLOG_FAC_SYSLOG   (5)
 SysLog (or Pantheios) messages.
#define PANTHEIOS_SYSLOG_FAC_LPR   (6)
 Printer messages.
#define PANTHEIOS_SYSLOG_FAC_NEWS   (7)
 Network news subsystem messages.
#define PANTHEIOS_SYSLOG_FAC_UUCP   (8)
 UUCP subsystem messages.
#define PANTHEIOS_SYSLOG_FAC_CRON   (9)
 Scheduler daemon messages.
#define PANTHEIOS_SYSLOG_FAC_AUTHPRIV   (10)
 Private security / authorisation messages.
#define PANTHEIOS_SYSLOG_FAC_FTP   (11)
 FTP daemon messages.
#define PANTHEIOS_SYSLOG_FAC_NETINFO   (12)
 NetInfo subsystem messages.
#define PANTHEIOS_SYSLOG_FAC_REMOTEAUTH   (13)
 Remote authentication / authorisation subsystem messages.
#define PANTHEIOS_SYSLOG_FAC_INSTALL   (14)
 Installer subsystem messages.
#define PANTHEIOS_SYSLOG_FAC_RAS   (15)
 RAS subsystem messages.
#define PANTHEIOS_SYSLOG_FAC_LOCAL0   (16)
 Reserved for local use.
#define PANTHEIOS_SYSLOG_FAC_LOCAL1   (17)
 Reserved for local use.
#define PANTHEIOS_SYSLOG_FAC_LOCAL2   (18)
 Reserved for local use.
#define PANTHEIOS_SYSLOG_FAC_LOCAL3   (19)
 Reserved for local use.
#define PANTHEIOS_SYSLOG_FAC_LOCAL4   (20)
 Reserved for local use.
#define PANTHEIOS_SYSLOG_FAC_LOCAL5   (21)
 Reserved for local use.
#define PANTHEIOS_SYSLOG_FAC_LOCAL6   (22)
 Reserved for local use.
#define PANTHEIOS_SYSLOG_FAC_LOCAL7   (23)
 Reserved for local use.
#define PANTHEIOS_SYSLOG_FAC_LAUNCHD   (24)
 Boostrap daemon subsystem messages.

Functions

void pantheios_be_WindowsSyslog_getAppInit (int backEndId, pan_be_WindowsSyslog_init_t *init)
 Callback function defined by the application, invoked when the API is initialised with a NULL init parameter.
void pantheios_be_WindowsSyslog_getDefaultAppInit (pan_be_WindowsSyslog_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_WindowsSyslog_init().
int pantheios_be_WindowsSyslog_init (PAN_CHAR_T const *processIdentity, int id, pan_be_WindowsSyslog_init_t const *init, void *reserved, void **ptoken)
 Implements the functionality for pantheios_be_init() over the Windows-SysLog API.
void pantheios_be_WindowsSyslog_uninit (void *token)
 Implements the functionality for pantheios_be_uninit() over the Windows-SysLog API.
int pantheios_be_WindowsSyslog_logEntry (void *feToken, void *beToken, int severity, PAN_CHAR_T const *entry, size_t cchEntry)
 Implements the functionality for pantheios_be_logEntry() over the Windows-SysLog API.
int pantheios_be_WindowsSyslog_parseArgs (size_t numArgs, pantheios::pan_slice_t *const args, pan_be_WindowsSyslog_init_t *init)
 Parses the be.WindowsSyslog back-end flags.

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