![]() |
![]() |
|
Pantheios comes with several pre-written stock front-end libraries, which cover most common needs for diagnostic logging. They also serve as good examples of how to write a custom front-end.
Modules | |
Pantheios all Stock Front-end | |
Front-end library that allows all severity levels in all modes. | |
Pantheios fail Stock Front-end | |
Front-end library that does not initialise. | |
Pantheios N Stock Front-end | |
Front-end library that can filter N back-ends. | |
Pantheios null Stock Front-end | |
Front-end library that suppresses all severity levels in all modes. | |
Pantheios simple Stock Front-end | |
Front-end library that allows all severity levels in debug mode and NOTICE and higher in release mode. | |
Pantheios Windows Registry Stock Front-end | |
Front-end library that allows all severity levels in debug mode and NOTICE and higher in release mode. | |
Functions | |
PAN_CHAR_T const * | pantheios_fe_getAppProcessIdentity (void) |
Callback function defined by the application, invoked during API initialisation. | |
Variables | |
PANTHEIOS_EXTERN_C PAN_CHAR_T const | PANTHEIOS_FE_PROCESS_IDENTITY [] |
The application must define this variable, to contain the application name/identity. |
PAN_CHAR_T const* pantheios_fe_getAppProcessIdentity | ( | void | ) |
Callback function defined by the application, invoked during API initialisation.
This function *MUST NOT* throw an exception, and *MUST NOT* return NULL
. If the implementation fails to acquire/produce the identity, it must call pantheios_exitProcess(1)
. It may optionally call pantheios_util_onBailOut4()
first.
PANTHEIOS_EXTERN_C PAN_CHAR_T const PANTHEIOS_FE_PROCESS_IDENTITY[] |
The application must define this variable, to contain the application name/identity.
The variable is an immutable array of PAN_CHAR_T
(i.e. char
in multibyte string builds, wchar_t
in wide string builds) whose name is non-mangled and has external linkage.
Therefore, when defining within a C++ compilation unit it must be declared extern "C"
; when defined within a C compilation unit it must be extern (optionally declared extern
; it must not be declared static
).
Examples:
// C: multibyte string build char const PANTHEIOS_FE_PROCESS_IDENTITY[] = "my.app"; // C++: wide string build extern "C" wchar_t const PANTHEIOS_FE_PROCESS_IDENTITY[] = L"my.app";
For convenience, the constructs PANTHEIOS_EXTERN_C, PAN_CHAR_T, and PANTHEIOS_LITERAL_STRING() may be employed to write the variable definition in a manner independent of language and/or character encoding, as in:
/\* C or C++; multibyte or wide string build \*\/ PANTHEIOS_EXTERN_C PAN_CHAR_T const PANTHEIOS_FE_PROCESS_IDENTITY[] = PANTHEIOS_LITERAL_STRING("my.app");
PAN_CHAR_T const*
) the behaviour of the link unit is undefined.
|
|
pantheios Library documentation © Matthew Wilson & Synesis Software, 2006-2011 |
|