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

pantheios/pantheios.h File Reference


Detailed Description

[C, C++] Primary include file for the Pantheios Core API and Pantheios Util API.

#include <stlsoft/stlsoft.h>
#include <stdarg.h>
#include <stddef.h>
#include <pantheios/internal/string_encoding.h>
#include "./internal/generated/log_functions.h"

Go to the source code of this file.

Namespaces

namespace  pantheios
namespace  pantheios::util
namespace  pantheios::core
namespace  pantheios::shims
namespace  stlsoft

Classes

struct  pan_slice_t
 String slice used by the Pantheios Application Layer API to communicate with the Pantheios Core API. More...

Defines

#define PANTHEIOS_VER_MAJOR   1
 The major version number of Pantheios.
#define PANTHEIOS_VER_MINOR   0
 The minor version number of Pantheios.
#define PANTHEIOS_VER_REVISION   1
 The revision version number of Pantheios.
#define PANTHEIOS_VER   PANTHEIOS_VER_1_0_1_B208
 The current composite version number of Pantheios.
#define PANTHEIOS_STRINGIZE(x)   PANTHEIOS_STRINGIZE_(x)
 Macro for stringizing symbols during preprocessing phase.
#define PANTHEIOS_MAKE_EXTENDED_SEVERITY(sev, xi28)
 Defines a composite severity level comprising a stock severity level and 28-bits of extended information.
#define PANTHEIOS_DECLSPEC
 Storage class specifier to be applied to all Pantheios API functions.
#define PANTHEIOS_EXTERN_C   extern "C"
 Resolves to extern when compiling in C, and extern "C" when compiling in C++.
#define PANTHEIOS_CALLCONV
 Calling convention specifier to be applied to all Pantheios API functions.
#define PANTHEIOS_CALL(rt)   PANTHEIOS_DECLSPEC PANTHEIOS_EXTERN_C rt PANTHEIOS_CALLCONV
 Used to declare and define Pantheios API functions.
#define PANTHEIOS_DECLARE_DEPRECATION(symtype, oldfn, newfn)
 Used to mark an inline (C++) function as deprecated.
#define PANTHEIOS_CALL_DEPRECATED(rt, oldfn, newfn)   PANTHEIOS_CALL(rt)
 Used to declare an API function as deprecated.
#define PANTHEIOS_NS_QUAL(x)   ::pantheios::x
 Puts x in the pantheios namespace if namespace is supported (and not suppressed), otherwise x is unqualified.
#define PANTHEIOS_SUBNS_QUAL(sns, x)   ::pantheios::sns::x
 Puts x in the pantheios::sns namespace if namespace is supported (and not suppressed), otherwise x is unqualified.
#define PAN_CHAR_T   PANTHEIOS_NS_QUAL(pan_char_t)
 The type pan_char_t, suitably namespace qualified in the contexts in which the pantheios namespace is operative.
#define PANTHEIOS_APPL_PARAMS_LIMIT   PANTHEIOS_APPL_PARAMS_LIMIT_MAX_GENERATED
 The number of parameters available in the Application Layer API, which can be overridden by defining it to a number between 1 and 32 to reduce compilation times where larger parameter lists are not required.
#define PANTHEIOS_SEV_EMERGENCY   ::pantheios::SEV_EMERGENCY
 Equivalent to pantheios::SEV_EMERGENCY.
#define PANTHEIOS_SEV_ALERT   ::pantheios::SEV_ALERT
 Equivalent to pantheios::SEV_ALERT.
#define PANTHEIOS_SEV_CRITICAL   ::pantheios::SEV_CRITICAL
 Equivalent to pantheios::SEV_CRITICAL.
#define PANTHEIOS_SEV_ERROR   ::pantheios::SEV_ERROR
 Equivalent to pantheios::SEV_ERROR.
#define PANTHEIOS_SEV_WARNING   ::pantheios::SEV_WARNING
 Equivalent to pantheios::SEV_WARNING.
#define PANTHEIOS_SEV_NOTICE   ::pantheios::SEV_NOTICE
 Equivalent to pantheios::SEV_NOTICE.
#define PANTHEIOS_SEV_INFORMATIONAL   ::pantheios::SEV_INFORMATIONAL
 Equivalent to pantheios::SEV_INFORMATIONAL.
#define PANTHEIOS_SEV_DEBUG   ::pantheios::SEV_DEBUG
 Equivalent to pantheios::SEV_DEBUG.

Typedefs

typedef stlsoft::ss_uint8_t pan_uint8_t
 8-bit unsigned integer type.
typedef stlsoft::ss_uint16_t pan_uint16_t
 16-bit unsigned integer type.
typedef stlsoft::ss_uint32_t pan_uint32_t
 32-bit unsigned integer type.
typedef stlsoft::ss_uint64_t pan_uint64_t
 64-bit unsigned integer type.
typedef stlsoft::ss_sint8_t pan_sint8_t
 8-bit signed integer type.
typedef stlsoft::ss_sint16_t pan_sint16_t
 16-bit signed integer type.
typedef stlsoft::ss_sint32_t pan_sint32_t
 32-bit signed integer type.
typedef stlsoft::ss_sint64_t pan_sint64_t
 64-bit signed integer type.
typedef char pan_char_t
 Character type used by the library.
typedef stlsoft::ss_sint32_t pan_sev_t
 Severity level type.
typedef pan_uint8_t uint8_t
 8-bit unsigned integer type.
typedef pan_uint16_t uint16_t
 16-bit unsigned integer type.
typedef pan_uint32_t uint32_t
 32-bit unsigned integer type.
typedef pan_uint64_t uint64_t
 64-bit unsigned integer type.
typedef pan_sint8_t sint8_t
 8-bit signed integer type.
typedef pan_sint16_t sint16_t
 16-bit signed integer type.
typedef pan_sint32_t sint32_t
 32-bit signed integer type.
typedef pan_sint64_t sint64_t
 64-bit signed integer type.

Enumerations

enum  pan_severity_t {
  SEV_EMERGENCY = 0,
  SEV_ALERT = 1,
  SEV_CRITICAL = 2,
  SEV_ERROR = 3,
  SEV_WARNING = 4,
  SEV_NOTICE = 5,
  SEV_INFORMATIONAL = 6,
  SEV_DEBUG = 7
}
 API Severity level. More...

Functions

pan_uint32_t pantheios_getVersion (void)
 Returns information about the version of Pantheios.
int pantheios_init (void)
 Initialises the Pantheios library.
void pantheios_uninit (void)
 Uninitialises the Pantheios library.
int pantheios_isSeverityLogged (pan_sev_t severity)
 Indicates whether a given severity is currently being logged by the process.
pan_char_t const * pantheios_getStockSeverityString (pan_sev_t severity)
 Returns a constant pointer to a non-NULL non-modifiable nul-terminated string representing the severity level.
size_t pantheios_getStockSeverityStringLength (pan_sev_t severity)
 Returns the length of the string returned by pantheios_getSeverityString().
char const * pantheios_getInitCodeString (int code)
 Returns a constant pointer to a non-NULL non-modifiable nul-terminated string representing the initialisation code.
size_t pantheios_getInitCodeStringLength (int code)
 Returns the length of the string returned by pantheios_getInitCodeString().
int pantheios_log_n (pan_sev_t severity, size_t numSlices, pantheios::pan_slice_t const *slices)
 Core logging function, which receives a severity and an array of string slices, and outputs them to the back-end.
int pantheios_log_1 (pan_sev_t severity, pan_char_t const *p0, int l0)
 Logs 1 parameter, subject to external (not in Pantheios Core API) severity-level filtering.
int pantheios_log_2 (pan_sev_t severity, pan_char_t const *p0, int l0, pan_char_t const *p1, int l1)
 Logs 2 parameters, subject to external (not in Pantheios Core API) severity-level filtering.
int pantheios_log_3 (pan_sev_t severity, pan_char_t const *p0, int l0, pan_char_t const *p1, int l1, pan_char_t const *p2, int l2)
 Logs 3 parameters, subject to external (not in Pantheios Core API) severity-level filtering.
int pantheios_log_4 (pan_sev_t severity, pan_char_t const *p0, int l0, pan_char_t const *p1, int l1, pan_char_t const *p2, int l2, pan_char_t const *p3, int l3)
 Logs 4 parameters, subject to external (not in Pantheios Core API) severity-level filtering.
int pantheios_log_5 (pan_sev_t severity, pan_char_t const *p0, int l0, pan_char_t const *p1, int l1, pan_char_t const *p2, int l2, pan_char_t const *p3, int l3, pan_char_t const *p4, int l4)
 Logs 5 parameters, subject to external (not in Pantheios Core API) severity-level filtering.
int pantheios_log_6 (pan_sev_t severity, pan_char_t const *p0, int l0, pan_char_t const *p1, int l1, pan_char_t const *p2, int l2, pan_char_t const *p3, int l3, pan_char_t const *p4, int l4, pan_char_t const *p5, int l5)
 Logs 6 parameters, subject to external (not in Pantheios Core API) severity-level filtering.
int pantheios_log_7 (pan_sev_t severity, pan_char_t const *p0, int l0, pan_char_t const *p1, int l1, pan_char_t const *p2, int l2, pan_char_t const *p3, int l3, pan_char_t const *p4, int l4, pan_char_t const *p5, int l5, pan_char_t const *p6, int l6)
 Logs 7 parameters, subject to external (not in Pantheios Core API) severity-level filtering.
int pantheios_log_8 (pan_sev_t severity, pan_char_t const *p0, int l0, pan_char_t const *p1, int l1, pan_char_t const *p2, int l2, pan_char_t const *p3, int l3, pan_char_t const *p4, int l4, pan_char_t const *p5, int l5, pan_char_t const *p6, int l6, pan_char_t const *p7, int l7)
 Logs 8 parameters, subject to external (not in Pantheios Core API) severity-level filtering.
int pantheios_log_9 (pan_sev_t severity, pan_char_t const *p0, int l0, pan_char_t const *p1, int l1, pan_char_t const *p2, int l2, pan_char_t const *p3, int l3, pan_char_t const *p4, int l4, pan_char_t const *p5, int l5, pan_char_t const *p6, int l6, pan_char_t const *p7, int l7, pan_char_t const *p8, int l8)
 Logs 9 parameters, subject to external (not in Pantheios Core API) severity-level filtering.
int pantheios_log_10 (pan_sev_t severity, pan_char_t const *p0, int l0, pan_char_t const *p1, int l1, pan_char_t const *p2, int l2, pan_char_t const *p3, int l3, pan_char_t const *p4, int l4, pan_char_t const *p5, int l5, pan_char_t const *p6, int l6, pan_char_t const *p7, int l7, pan_char_t const *p8, int l8, pan_char_t const *p9, int l9)
 Logs 10 parameters, subject to external (not in Pantheios Core API) severity-level filtering.
int pantheios_log_11 (pan_sev_t severity, pan_char_t const *p0, int l0, pan_char_t const *p1, int l1, pan_char_t const *p2, int l2, pan_char_t const *p3, int l3, pan_char_t const *p4, int l4, pan_char_t const *p5, int l5, pan_char_t const *p6, int l6, pan_char_t const *p7, int l7, pan_char_t const *p8, int l8, pan_char_t const *p9, int l9, pan_char_t const *p10, int l10)
 Logs 11 parameters, subject to external (not in Pantheios Core API) severity-level filtering.
int pantheios_log_12 (pan_sev_t severity, pan_char_t const *p0, int l0, pan_char_t const *p1, int l1, pan_char_t const *p2, int l2, pan_char_t const *p3, int l3, pan_char_t const *p4, int l4, pan_char_t const *p5, int l5, pan_char_t const *p6, int l6, pan_char_t const *p7, int l7, pan_char_t const *p8, int l8, pan_char_t const *p9, int l9, pan_char_t const *p10, int l10, pan_char_t const *p11, int l11)
 Logs 12 parameters, subject to external (not in Pantheios Core API) severity-level filtering.
int pantheios_log_13 (pan_sev_t severity, pan_char_t const *p0, int l0, pan_char_t const *p1, int l1, pan_char_t const *p2, int l2, pan_char_t const *p3, int l3, pan_char_t const *p4, int l4, pan_char_t const *p5, int l5, pan_char_t const *p6, int l6, pan_char_t const *p7, int l7, pan_char_t const *p8, int l8, pan_char_t const *p9, int l9, pan_char_t const *p10, int l10, pan_char_t const *p11, int l11, pan_char_t const *p12, int l12)
 Logs 13 parameters, subject to external (not in Pantheios Core API) severity-level filtering.
int pantheios_log_14 (pan_sev_t severity, pan_char_t const *p0, int l0, pan_char_t const *p1, int l1, pan_char_t const *p2, int l2, pan_char_t const *p3, int l3, pan_char_t const *p4, int l4, pan_char_t const *p5, int l5, pan_char_t const *p6, int l6, pan_char_t const *p7, int l7, pan_char_t const *p8, int l8, pan_char_t const *p9, int l9, pan_char_t const *p10, int l10, pan_char_t const *p11, int l11, pan_char_t const *p12, int l12, pan_char_t const *p13, int l13)
 Logs 14 parameters, subject to external (not in Pantheios Core API) severity-level filtering.
int pantheios_log_15 (pan_sev_t severity, pan_char_t const *p0, int l0, pan_char_t const *p1, int l1, pan_char_t const *p2, int l2, pan_char_t const *p3, int l3, pan_char_t const *p4, int l4, pan_char_t const *p5, int l5, pan_char_t const *p6, int l6, pan_char_t const *p7, int l7, pan_char_t const *p8, int l8, pan_char_t const *p9, int l9, pan_char_t const *p10, int l10, pan_char_t const *p11, int l11, pan_char_t const *p12, int l12, pan_char_t const *p13, int l13, pan_char_t const *p14, int l14)
 Logs 15 parameters, subject to external (not in Pantheios Core API) severity-level filtering.
int pantheios_log_16 (pan_sev_t severity, pan_char_t const *p0, int l0, pan_char_t const *p1, int l1, pan_char_t const *p2, int l2, pan_char_t const *p3, int l3, pan_char_t const *p4, int l4, pan_char_t const *p5, int l5, pan_char_t const *p6, int l6, pan_char_t const *p7, int l7, pan_char_t const *p8, int l8, pan_char_t const *p9, int l9, pan_char_t const *p10, int l10, pan_char_t const *p11, int l11, pan_char_t const *p12, int l12, pan_char_t const *p13, int l13, pan_char_t const *p14, int l14, pan_char_t const *p15, int l15)
 Logs 16 parameters, subject to external (not in Pantheios Core API) severity-level filtering.
int pantheios_log_17 (pan_sev_t severity, pan_char_t const *p0, int l0, pan_char_t const *p1, int l1, pan_char_t const *p2, int l2, pan_char_t const *p3, int l3, pan_char_t const *p4, int l4, pan_char_t const *p5, int l5, pan_char_t const *p6, int l6, pan_char_t const *p7, int l7, pan_char_t const *p8, int l8, pan_char_t const *p9, int l9, pan_char_t const *p10, int l10, pan_char_t const *p11, int l11, pan_char_t const *p12, int l12, pan_char_t const *p13, int l13, pan_char_t const *p14, int l14, pan_char_t const *p15, int l15, pan_char_t const *p16, int l16)
 Logs 17 parameters, subject to external (not in Pantheios Core API) severity-level filtering.
int pantheios_log_18 (pan_sev_t severity, pan_char_t const *p0, int l0, pan_char_t const *p1, int l1, pan_char_t const *p2, int l2, pan_char_t const *p3, int l3, pan_char_t const *p4, int l4, pan_char_t const *p5, int l5, pan_char_t const *p6, int l6, pan_char_t const *p7, int l7, pan_char_t const *p8, int l8, pan_char_t const *p9, int l9, pan_char_t const *p10, int l10, pan_char_t const *p11, int l11, pan_char_t const *p12, int l12, pan_char_t const *p13, int l13, pan_char_t const *p14, int l14, pan_char_t const *p15, int l15, pan_char_t const *p16, int l16, pan_char_t const *p17, int l17)
 Logs 18 parameters, subject to external (not in Pantheios Core API) severity-level filtering.
int pantheios_log_19 (pan_sev_t severity, pan_char_t const *p0, int l0, pan_char_t const *p1, int l1, pan_char_t const *p2, int l2, pan_char_t const *p3, int l3, pan_char_t const *p4, int l4, pan_char_t const *p5, int l5, pan_char_t const *p6, int l6, pan_char_t const *p7, int l7, pan_char_t const *p8, int l8, pan_char_t const *p9, int l9, pan_char_t const *p10, int l10, pan_char_t const *p11, int l11, pan_char_t const *p12, int l12, pan_char_t const *p13, int l13, pan_char_t const *p14, int l14, pan_char_t const *p15, int l15, pan_char_t const *p16, int l16, pan_char_t const *p17, int l17, pan_char_t const *p18, int l18)
 Logs 19 parameters, subject to external (not in Pantheios Core API) severity-level filtering.
int pantheios_log_20 (pan_sev_t severity, pan_char_t const *p0, int l0, pan_char_t const *p1, int l1, pan_char_t const *p2, int l2, pan_char_t const *p3, int l3, pan_char_t const *p4, int l4, pan_char_t const *p5, int l5, pan_char_t const *p6, int l6, pan_char_t const *p7, int l7, pan_char_t const *p8, int l8, pan_char_t const *p9, int l9, pan_char_t const *p10, int l10, pan_char_t const *p11, int l11, pan_char_t const *p12, int l12, pan_char_t const *p13, int l13, pan_char_t const *p14, int l14, pan_char_t const *p15, int l15, pan_char_t const *p16, int l16, pan_char_t const *p17, int l17, pan_char_t const *p18, int l18, pan_char_t const *p19, int l19)
 Logs 20 parameters, subject to external (not in Pantheios Core API) severity-level filtering.
int pantheios_log_21 (pan_sev_t severity, pan_char_t const *p0, int l0, pan_char_t const *p1, int l1, pan_char_t const *p2, int l2, pan_char_t const *p3, int l3, pan_char_t const *p4, int l4, pan_char_t const *p5, int l5, pan_char_t const *p6, int l6, pan_char_t const *p7, int l7, pan_char_t const *p8, int l8, pan_char_t const *p9, int l9, pan_char_t const *p10, int l10, pan_char_t const *p11, int l11, pan_char_t const *p12, int l12, pan_char_t const *p13, int l13, pan_char_t const *p14, int l14, pan_char_t const *p15, int l15, pan_char_t const *p16, int l16, pan_char_t const *p17, int l17, pan_char_t const *p18, int l18, pan_char_t const *p19, int l19, pan_char_t const *p20, int l20)
 Logs 21 parameters, subject to external (not in Pantheios Core API) severity-level filtering.
int pantheios_log_22 (pan_sev_t severity, pan_char_t const *p0, int l0, pan_char_t const *p1, int l1, pan_char_t const *p2, int l2, pan_char_t const *p3, int l3, pan_char_t const *p4, int l4, pan_char_t const *p5, int l5, pan_char_t const *p6, int l6, pan_char_t const *p7, int l7, pan_char_t const *p8, int l8, pan_char_t const *p9, int l9, pan_char_t const *p10, int l10, pan_char_t const *p11, int l11, pan_char_t const *p12, int l12, pan_char_t const *p13, int l13, pan_char_t const *p14, int l14, pan_char_t const *p15, int l15, pan_char_t const *p16, int l16, pan_char_t const *p17, int l17, pan_char_t const *p18, int l18, pan_char_t const *p19, int l19, pan_char_t const *p20, int l20, pan_char_t const *p21, int l21)
 Logs 22 parameters, subject to external (not in Pantheios Core API) severity-level filtering.
int pantheios_log_23 (pan_sev_t severity, pan_char_t const *p0, int l0, pan_char_t const *p1, int l1, pan_char_t const *p2, int l2, pan_char_t const *p3, int l3, pan_char_t const *p4, int l4, pan_char_t const *p5, int l5, pan_char_t const *p6, int l6, pan_char_t const *p7, int l7, pan_char_t const *p8, int l8, pan_char_t const *p9, int l9, pan_char_t const *p10, int l10, pan_char_t const *p11, int l11, pan_char_t const *p12, int l12, pan_char_t const *p13, int l13, pan_char_t const *p14, int l14, pan_char_t const *p15, int l15, pan_char_t const *p16, int l16, pan_char_t const *p17, int l17, pan_char_t const *p18, int l18, pan_char_t const *p19, int l19, pan_char_t const *p20, int l20, pan_char_t const *p21, int l21, pan_char_t const *p22, int l22)
 Logs 23 parameters, subject to external (not in Pantheios Core API) severity-level filtering.
int pantheios_log_24 (pan_sev_t severity, pan_char_t const *p0, int l0, pan_char_t const *p1, int l1, pan_char_t const *p2, int l2, pan_char_t const *p3, int l3, pan_char_t const *p4, int l4, pan_char_t const *p5, int l5, pan_char_t const *p6, int l6, pan_char_t const *p7, int l7, pan_char_t const *p8, int l8, pan_char_t const *p9, int l9, pan_char_t const *p10, int l10, pan_char_t const *p11, int l11, pan_char_t const *p12, int l12, pan_char_t const *p13, int l13, pan_char_t const *p14, int l14, pan_char_t const *p15, int l15, pan_char_t const *p16, int l16, pan_char_t const *p17, int l17, pan_char_t const *p18, int l18, pan_char_t const *p19, int l19, pan_char_t const *p20, int l20, pan_char_t const *p21, int l21, pan_char_t const *p22, int l22, pan_char_t const *p23, int l23)
 Logs 24 parameters, subject to external (not in Pantheios Core API) severity-level filtering.
int pantheios_log_25 (pan_sev_t severity, pan_char_t const *p0, int l0, pan_char_t const *p1, int l1, pan_char_t const *p2, int l2, pan_char_t const *p3, int l3, pan_char_t const *p4, int l4, pan_char_t const *p5, int l5, pan_char_t const *p6, int l6, pan_char_t const *p7, int l7, pan_char_t const *p8, int l8, pan_char_t const *p9, int l9, pan_char_t const *p10, int l10, pan_char_t const *p11, int l11, pan_char_t const *p12, int l12, pan_char_t const *p13, int l13, pan_char_t const *p14, int l14, pan_char_t const *p15, int l15, pan_char_t const *p16, int l16, pan_char_t const *p17, int l17, pan_char_t const *p18, int l18, pan_char_t const *p19, int l19, pan_char_t const *p20, int l20, pan_char_t const *p21, int l21, pan_char_t const *p22, int l22, pan_char_t const *p23, int l23, pan_char_t const *p24, int l24)
 Logs 25 parameters, subject to external (not in Pantheios Core API) severity-level filtering.
int pantheios_log_26 (pan_sev_t severity, pan_char_t const *p0, int l0, pan_char_t const *p1, int l1, pan_char_t const *p2, int l2, pan_char_t const *p3, int l3, pan_char_t const *p4, int l4, pan_char_t const *p5, int l5, pan_char_t const *p6, int l6, pan_char_t const *p7, int l7, pan_char_t const *p8, int l8, pan_char_t const *p9, int l9, pan_char_t const *p10, int l10, pan_char_t const *p11, int l11, pan_char_t const *p12, int l12, pan_char_t const *p13, int l13, pan_char_t const *p14, int l14, pan_char_t const *p15, int l15, pan_char_t const *p16, int l16, pan_char_t const *p17, int l17, pan_char_t const *p18, int l18, pan_char_t const *p19, int l19, pan_char_t const *p20, int l20, pan_char_t const *p21, int l21, pan_char_t const *p22, int l22, pan_char_t const *p23, int l23, pan_char_t const *p24, int l24, pan_char_t const *p25, int l25)
 Logs 26 parameters, subject to external (not in Pantheios Core API) severity-level filtering.
int pantheios_log_27 (pan_sev_t severity, pan_char_t const *p0, int l0, pan_char_t const *p1, int l1, pan_char_t const *p2, int l2, pan_char_t const *p3, int l3, pan_char_t const *p4, int l4, pan_char_t const *p5, int l5, pan_char_t const *p6, int l6, pan_char_t const *p7, int l7, pan_char_t const *p8, int l8, pan_char_t const *p9, int l9, pan_char_t const *p10, int l10, pan_char_t const *p11, int l11, pan_char_t const *p12, int l12, pan_char_t const *p13, int l13, pan_char_t const *p14, int l14, pan_char_t const *p15, int l15, pan_char_t const *p16, int l16, pan_char_t const *p17, int l17, pan_char_t const *p18, int l18, pan_char_t const *p19, int l19, pan_char_t const *p20, int l20, pan_char_t const *p21, int l21, pan_char_t const *p22, int l22, pan_char_t const *p23, int l23, pan_char_t const *p24, int l24, pan_char_t const *p25, int l25, pan_char_t const *p26, int l26)
 Logs 27 parameters, subject to external (not in Pantheios Core API) severity-level filtering.
int pantheios_log_28 (pan_sev_t severity, pan_char_t const *p0, int l0, pan_char_t const *p1, int l1, pan_char_t const *p2, int l2, pan_char_t const *p3, int l3, pan_char_t const *p4, int l4, pan_char_t const *p5, int l5, pan_char_t const *p6, int l6, pan_char_t const *p7, int l7, pan_char_t const *p8, int l8, pan_char_t const *p9, int l9, pan_char_t const *p10, int l10, pan_char_t const *p11, int l11, pan_char_t const *p12, int l12, pan_char_t const *p13, int l13, pan_char_t const *p14, int l14, pan_char_t const *p15, int l15, pan_char_t const *p16, int l16, pan_char_t const *p17, int l17, pan_char_t const *p18, int l18, pan_char_t const *p19, int l19, pan_char_t const *p20, int l20, pan_char_t const *p21, int l21, pan_char_t const *p22, int l22, pan_char_t const *p23, int l23, pan_char_t const *p24, int l24, pan_char_t const *p25, int l25, pan_char_t const *p26, int l26, pan_char_t const *p27, int l27)
 Logs 28 parameters, subject to external (not in Pantheios Core API) severity-level filtering.
int pantheios_log_29 (pan_sev_t severity, pan_char_t const *p0, int l0, pan_char_t const *p1, int l1, pan_char_t const *p2, int l2, pan_char_t const *p3, int l3, pan_char_t const *p4, int l4, pan_char_t const *p5, int l5, pan_char_t const *p6, int l6, pan_char_t const *p7, int l7, pan_char_t const *p8, int l8, pan_char_t const *p9, int l9, pan_char_t const *p10, int l10, pan_char_t const *p11, int l11, pan_char_t const *p12, int l12, pan_char_t const *p13, int l13, pan_char_t const *p14, int l14, pan_char_t const *p15, int l15, pan_char_t const *p16, int l16, pan_char_t const *p17, int l17, pan_char_t const *p18, int l18, pan_char_t const *p19, int l19, pan_char_t const *p20, int l20, pan_char_t const *p21, int l21, pan_char_t const *p22, int l22, pan_char_t const *p23, int l23, pan_char_t const *p24, int l24, pan_char_t const *p25, int l25, pan_char_t const *p26, int l26, pan_char_t const *p27, int l27, pan_char_t const *p28, int l28)
 Logs 29 parameters, subject to external (not in Pantheios Core API) severity-level filtering.
int pantheios_log_30 (pan_sev_t severity, pan_char_t const *p0, int l0, pan_char_t const *p1, int l1, pan_char_t const *p2, int l2, pan_char_t const *p3, int l3, pan_char_t const *p4, int l4, pan_char_t const *p5, int l5, pan_char_t const *p6, int l6, pan_char_t const *p7, int l7, pan_char_t const *p8, int l8, pan_char_t const *p9, int l9, pan_char_t const *p10, int l10, pan_char_t const *p11, int l11, pan_char_t const *p12, int l12, pan_char_t const *p13, int l13, pan_char_t const *p14, int l14, pan_char_t const *p15, int l15, pan_char_t const *p16, int l16, pan_char_t const *p17, int l17, pan_char_t const *p18, int l18, pan_char_t const *p19, int l19, pan_char_t const *p20, int l20, pan_char_t const *p21, int l21, pan_char_t const *p22, int l22, pan_char_t const *p23, int l23, pan_char_t const *p24, int l24, pan_char_t const *p25, int l25, pan_char_t const *p26, int l26, pan_char_t const *p27, int l27, pan_char_t const *p28, int l28, pan_char_t const *p29, int l29)
 Logs 30 parameters, subject to external (not in Pantheios Core API) severity-level filtering.
int pantheios_log_31 (pan_sev_t severity, pan_char_t const *p0, int l0, pan_char_t const *p1, int l1, pan_char_t const *p2, int l2, pan_char_t const *p3, int l3, pan_char_t const *p4, int l4, pan_char_t const *p5, int l5, pan_char_t const *p6, int l6, pan_char_t const *p7, int l7, pan_char_t const *p8, int l8, pan_char_t const *p9, int l9, pan_char_t const *p10, int l10, pan_char_t const *p11, int l11, pan_char_t const *p12, int l12, pan_char_t const *p13, int l13, pan_char_t const *p14, int l14, pan_char_t const *p15, int l15, pan_char_t const *p16, int l16, pan_char_t const *p17, int l17, pan_char_t const *p18, int l18, pan_char_t const *p19, int l19, pan_char_t const *p20, int l20, pan_char_t const *p21, int l21, pan_char_t const *p22, int l22, pan_char_t const *p23, int l23, pan_char_t const *p24, int l24, pan_char_t const *p25, int l25, pan_char_t const *p26, int l26, pan_char_t const *p27, int l27, pan_char_t const *p28, int l28, pan_char_t const *p29, int l29, pan_char_t const *p30, int l30)
 Logs 31 parameters, subject to external (not in Pantheios Core API) severity-level filtering.
int pantheios_log_32 (pan_sev_t severity, pan_char_t const *p0, int l0, pan_char_t const *p1, int l1, pan_char_t const *p2, int l2, pan_char_t const *p3, int l3, pan_char_t const *p4, int l4, pan_char_t const *p5, int l5, pan_char_t const *p6, int l6, pan_char_t const *p7, int l7, pan_char_t const *p8, int l8, pan_char_t const *p9, int l9, pan_char_t const *p10, int l10, pan_char_t const *p11, int l11, pan_char_t const *p12, int l12, pan_char_t const *p13, int l13, pan_char_t const *p14, int l14, pan_char_t const *p15, int l15, pan_char_t const *p16, int l16, pan_char_t const *p17, int l17, pan_char_t const *p18, int l18, pan_char_t const *p19, int l19, pan_char_t const *p20, int l20, pan_char_t const *p21, int l21, pan_char_t const *p22, int l22, pan_char_t const *p23, int l23, pan_char_t const *p24, int l24, pan_char_t const *p25, int l25, pan_char_t const *p26, int l26, pan_char_t const *p27, int l27, pan_char_t const *p28, int l28, pan_char_t const *p29, int l29, pan_char_t const *p30, int l30, pan_char_t const *p31, int l31)
 Logs 32 parameters, subject to external (not in Pantheios Core API) severity-level filtering.
int pantheios_logprintf (pan_sev_t severity, pan_char_t const *format,...)
 printf()-form of logging function, passing the formatted result to the back-end
int pantheios_logvprintf (pan_sev_t severity, pan_char_t const *format, va_list args)
 vprintf()-form of logging function, passing the formatted result to the back-end
void pantheios_onBailOut4 (int severity, char const *message, char const *processId, char const *qualifier)
 Prints a bail-out message to operating system-dependent facilities (e.g.
void pantheios_onBailOut3 (int severity, char const *message, char const *processId)
 Prints a bail-out message to operating system-dependent facilities (e.g.
int pantheios_getNextBackEndId (void)
 Returns a (thread-safe) unique back-end identifier.
void pantheios_logputs (pan_sev_t severity, pan_char_t const *message)
 A functional equivalent to puts(), incorporating a severity level.
void pantheios_puts (pan_sev_t severity, pan_char_t const *message)
 [DEPRECATED] Equivalent to pantheios_logputs().
int isSeverityLogged (pan_sev_t severity)
 Equivalent to pantheios_isSeverityLogged().
pan_char_t const * getStockSeverityString (pan_sev_t severity)
 Equivalent to pantheios_getStockSeverityString().
size_t getStockSeverityStringLength (pan_sev_t severity)
 Equivalent to pantheios_getStockSeverityStringLength().
char const * getInitCodeString (int code)
 Equivalent to pantheios_getInitCodeString().
size_t getInitCodeStringLength (int code)
 Equivalent to pantheios_getInitCodeStringLength().
int getNextBackEndId ()
 Equivalent to pantheios_getNextBackEndId().
void logputs (pan_sev_t severity, pan_char_t const *message)
 Equivalent to pantheios_logputs().
void puts (pan_sev_t severity, pan_char_t const *message)
 [DEPRECATED] Equivalent to pantheios_logputs().
int logprintf (pan_sev_t severity, pan_char_t const *format,...)
 Equivalent to pantheios_logprintf().
int logvprintf (pan_sev_t severity, pan_char_t const *format, va_list args)
 Equivalent to pantheios_logvprintf().
char const * c_str_ptr_a (pan_slice_t const &s)
 Returns a nul-terminated non-NULL C-style string representing the slice.
pan_char_t const * c_str_ptr (pan_slice_t const &s)
 Returns a nul-terminated non-NULL C-style string representing the slice.
char const * c_str_ptr_null_a (pan_slice_t const &s)
 Returns a nul-terminated potentially null C-style string representing the slice.
pan_char_t const * c_str_ptr_null (pan_slice_t const &s)
 Returns a nul-terminated potentially null C-style string representing the slice.
char const * c_str_data_a (pan_slice_t const &s)
 Returns a possibly non-nul-terminated non-NULL C-style string representing the slice.
pan_char_t const * c_str_data (pan_slice_t const &s)
 Returns a possibly non-nul-terminated non-NULL C-style string representing the slice.
size_t c_str_len_a (pan_slice_t const &s)
 Returns the number of characters in the length of the C-style string representing the slice.
size_t c_str_len (pan_slice_t const &s)
 Returns the number of characters in the length of the C-style string representing the slice.
char const * c_str_ptr_a (pan_slice_t const *s)
 Returns a nul-terminated non-NULL C-style string representing the slice.
pan_char_t const * c_str_ptr (pan_slice_t const *s)
 Returns a nul-terminated non-NULL C-style string representing the slice.
char const * c_str_ptr_null_a (pan_slice_t const *s)
 Returns a nul-terminated potentially null C-style string representing the slice.
pan_char_t const * c_str_ptr_null (pan_slice_t const *s)
 Returns a nul-terminated potentially null C-style string representing the slice.
char const * c_str_data_a (pan_slice_t const *s)
 Returns a possibly non-nul-terminated non-NULL C-style string representing the slice.
pan_char_t const * c_str_data (pan_slice_t const *s)
 Returns a possibly non-nul-terminated non-NULL C-style string representing the slice.
size_t c_str_len_a (pan_slice_t const *s)
 Returns the number of characters in the length of the C-style string representing the slice.
size_t c_str_len (pan_slice_t const *s)
 Returns the number of characters in the length of the C-style string representing the slice.
char const * c_str_data_a (pan_severity_t severity)
 Returns a possibly non-nul-terminated non-NULL C-style string representing the severity.
pan_char_t const * c_str_data (pan_severity_t severity)
 Returns a possibly non-nul-terminated non-NULL C-style string representing the severity.
size_t c_str_len_a (pan_severity_t severity)
 Returns the number of characters in the length of the C-style string representing the severity.
size_t c_str_len (pan_severity_t severity)
 Returns the number of characters in the length of the C-style string representing the severity.
char const * c_str_ptr_a (pan_severity_t severity)
 Returns a nul-terminated non-NULL C-style string representing the severity.
pan_char_t const * c_str_ptr (pan_severity_t severity)
 Returns a nul-terminated non-NULL C-style string representing the severity.
char const * c_str_ptr_null_a (pan_severity_t severity)
 Returns a nul-terminated potentially null C-style string representing the severity.
pan_char_t const * c_str_ptr_null (pan_severity_t severity)
 Returns a nul-terminated potentially null C-style string representing the severity.


Define Documentation

#define PAN_CHAR_T   PANTHEIOS_NS_QUAL(pan_char_t)

The type pan_char_t, suitably namespace qualified in the contexts in which the pantheios namespace is operative.

Acts as a convenient shorthand for pantheios::pan_char_t when in C++ (and namespace not suppressed) or pan_char_t otherwise.

Examples:
c/example.c.core.pantheios_logprintf/example.c.core.pantheios_logprintf.c, c/example.c.extended_severity/example.c.extended_severity.c, c/example.c.log_n/example.c.log_n.c, c/example.c.N/example.c.N.c, cpp/backends/example.cpp.backends.callback/example.cpp.backends.callback.cpp, cpp/backends/example.cpp.backends.file.callback/example.cpp.backends.file.callback.cpp, cpp/backends/example.cpp.backends.file.lrsplit/example.cpp.backends.file.lrsplit.cpp, cpp/backends/example.cpp.backends.file/example.cpp.backends.file.cpp, cpp/backends/example.cpp.backends.mx.1/example.cpp.backends.mx.1.cpp, cpp/backends/example.cpp.backends.mx.2/example.cpp.backends.mx.2.cpp, cpp/contract/example.cpp.contract.PANTHEIOS_ASSERT/example.cpp.contract.PANTHEIOS_ASSERT.cpp, cpp/contract/example.cpp.contract.PANTHEIOS_MESSAGE_ASSERT/example.cpp.contract.PANTHEIOS_MESSAGE_ASSERT.cpp, cpp/format/example.cpp.format.highres/example.cpp.format.highres.cpp, cpp/format/example.cpp.format.lowres/example.cpp.format.lowres.cpp, cpp/format/example.cpp.format.pad/example.cpp.format.pad.cpp, cpp/frontends/example.cpp.frontends.custom/example.cpp.frontends.custom.cpp, cpp/inserters/example.cpp.inserter.args/example.cpp.inserter.args.cpp, cpp/inserters/example.cpp.inserter.b/example.cpp.inserter.b.cpp, cpp/inserters/example.cpp.inserter.b64/example.cpp.inserter.b64.cpp, cpp/inserters/example.cpp.inserter.blob/example.cpp.inserter.blob.cpp, cpp/inserters/example.cpp.inserter.character/example.cpp.inserter.character.cpp, cpp/inserters/example.cpp.inserter.hex_ptr/example.cpp.inserter.hex_ptr.cpp, cpp/inserters/example.cpp.inserter.hostid/example.cpp.inserter.hostid.cpp, cpp/inserters/example.cpp.inserter.i/example.cpp.inserter.i.cpp, cpp/inserters/example.cpp.inserter.integer/example.cpp.inserter.integer.cpp, cpp/inserters/example.cpp.inserter.m2w/example.cpp.inserter.m2w.cpp, cpp/inserters/example.cpp.inserter.p/example.cpp.inserter.p.cpp, cpp/inserters/example.cpp.inserter.pointer/example.cpp.inserter.pointer.cpp, cpp/inserters/example.cpp.inserter.processid/example.cpp.inserter.processid.cpp, cpp/inserters/example.cpp.inserter.real/example.cpp.inserter.real.cpp, cpp/inserters/example.cpp.inserter.threadid/example.cpp.inserter.threadid.cpp, cpp/inserters/example.cpp.inserter.w2m/example.cpp.inserter.w2m.cpp, cpp/inserters/example.cpp.inserter.xi/example.cpp.inserter.xi.cpp, cpp/inserters/example.cpp.inserter.xp/example.cpp.inserter.xp.cpp, cpp/linking/example.cpp.linking.implicit_link_1/example.cpp.linking.implicit_link_1.cpp, cpp/misc/example.cpp.misc.101/example.cpp.misc.101.cpp, cpp/misc/example.cpp.misc.custom_type_1/example.cpp.misc.custom_type_1.cpp, cpp/misc/example.cpp.misc.extended_severity_information/example.cpp.misc.extended_severity_information.cpp, cpp/misc/example.cpp.misc.hetero1/example.cpp.misc.hetero1.cpp, cpp/misc/example.cpp.misc.no_namespace/example.cpp.misc.no_namespace.cpp, cpp/misc/example.cpp.misc.strings/example.cpp.misc.strings.cpp, cpp/tracing/example.cpp.tracing.standard/example.cpp.tracing.standard.cpp, and cpp/tracing/example.cpp.tracing.with_function/example.cpp.tracing.with_function.cpp.

#define PANTHEIOS_APPL_PARAMS_LIMIT   PANTHEIOS_APPL_PARAMS_LIMIT_MAX_GENERATED

The number of parameters available in the Application Layer API, which can be overridden by defining it to a number between 1 and 32 to reduce compilation times where larger parameter lists are not required.

#define PANTHEIOS_MAKE_EXTENDED_SEVERITY ( sev,
xi28   ) 

Value:

\
    (((sev) & 0x0f) | (((xi28) << 4) & ~0x0f))
Defines a composite severity level comprising a stock severity level and 28-bits of extended information.

Parameters:
sev A stock severity level
xi28 The extended severity information. Must be no larger than 28-bits
Precondition:
0 == (xi28 & ~0xf0000000)
Examples:
c/example.c.extended_severity/example.c.extended_severity.c.

#define PANTHEIOS_NS_QUAL (  )     ::pantheios::x

Puts x in the pantheios namespace if namespace is supported (and not suppressed), otherwise x is unqualified.

#define PANTHEIOS_SEV_ALERT   ::pantheios::SEV_ALERT

Equivalent to pantheios::SEV_ALERT.

Examples:
c/example.c.N/example.c.N.c, cpp/custom/example.cpp.custom.wrap_log4cplus/example.cpp.custom.wrap_log4cplus.cpp, and cpp/custom/example.cpp.custom.wrap_log4cxx/example.cpp.custom.wrap_log4cxx.cpp.

#define PANTHEIOS_SEV_CRITICAL   ::pantheios::SEV_CRITICAL

Equivalent to pantheios::SEV_CRITICAL.

Examples:
c/example.c.log_n/example.c.log_n.c, c/example.c.N/example.c.N.c, cpp/custom/example.cpp.custom.wrap_log4cplus/example.cpp.custom.wrap_log4cplus.cpp, and cpp/custom/example.cpp.custom.wrap_log4cxx/example.cpp.custom.wrap_log4cxx.cpp.

#define PANTHEIOS_SEV_DEBUG   ::pantheios::SEV_DEBUG

Equivalent to pantheios::SEV_DEBUG.

Examples:
c/example.c.N/example.c.N.c, cpp/custom/example.cpp.custom.wrap_log4cplus/example.cpp.custom.wrap_log4cplus.cpp, and cpp/custom/example.cpp.custom.wrap_log4cxx/example.cpp.custom.wrap_log4cxx.cpp.

#define PANTHEIOS_SEV_EMERGENCY   ::pantheios::SEV_EMERGENCY

Equivalent to pantheios::SEV_EMERGENCY.

Examples:
c/example.c.N/example.c.N.c, cpp/custom/example.cpp.custom.wrap_log4cplus/example.cpp.custom.wrap_log4cplus.cpp, and cpp/custom/example.cpp.custom.wrap_log4cxx/example.cpp.custom.wrap_log4cxx.cpp.

#define PANTHEIOS_SEV_ERROR   ::pantheios::SEV_ERROR

Equivalent to pantheios::SEV_ERROR.

Examples:
c/example.c.N/example.c.N.c, cpp/custom/example.cpp.custom.wrap_log4cplus/example.cpp.custom.wrap_log4cplus.cpp, and cpp/custom/example.cpp.custom.wrap_log4cxx/example.cpp.custom.wrap_log4cxx.cpp.

#define PANTHEIOS_SEV_INFORMATIONAL   ::pantheios::SEV_INFORMATIONAL

Equivalent to pantheios::SEV_INFORMATIONAL.

Examples:
c/example.c.core.pantheios_logprintf/example.c.core.pantheios_logprintf.c, c/example.c.N/example.c.N.c, cpp/custom/example.cpp.custom.wrap_log4cplus/example.cpp.custom.wrap_log4cplus.cpp, and cpp/custom/example.cpp.custom.wrap_log4cxx/example.cpp.custom.wrap_log4cxx.cpp.

#define PANTHEIOS_SEV_NOTICE   ::pantheios::SEV_NOTICE

Equivalent to pantheios::SEV_NOTICE.

Examples:
c/example.c.extended_severity/example.c.extended_severity.c, c/example.c.N/example.c.N.c, cpp/custom/example.cpp.custom.wrap_log4cplus/example.cpp.custom.wrap_log4cplus.cpp, cpp/custom/example.cpp.custom.wrap_log4cxx/example.cpp.custom.wrap_log4cxx.cpp, and cpp/misc/example.cpp.misc.101/example.cpp.misc.101.cpp.

#define PANTHEIOS_SEV_WARNING   ::pantheios::SEV_WARNING

Equivalent to pantheios::SEV_WARNING.

Examples:
c/example.c.N/example.c.N.c, cpp/custom/example.cpp.custom.wrap_log4cplus/example.cpp.custom.wrap_log4cplus.cpp, cpp/custom/example.cpp.custom.wrap_log4cxx/example.cpp.custom.wrap_log4cxx.cpp, and cpp/misc/example.cpp.misc.101/example.cpp.misc.101.cpp.

#define PANTHEIOS_SUBNS_QUAL ( sns,
 )     ::pantheios::sns::x

Puts x in the pantheios::sns namespace if namespace is supported (and not suppressed), otherwise x is unqualified.

#define PANTHEIOS_VER   PANTHEIOS_VER_1_0_1_B208

The current composite version number of Pantheios.

#define PANTHEIOS_VER_MAJOR   1

The major version number of Pantheios.

#define PANTHEIOS_VER_MINOR   0

The minor version number of Pantheios.

#define PANTHEIOS_VER_REVISION   1

The revision version number of Pantheios.


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