stumpless 2.2.0
Loading...
Searching...
No Matches
config.h File Reference

Configuration information to provide to code built with the library. More...

Go to the source code of this file.

Macros

#define STUMPLESS_PUBLIC_FUNCTION   __attribute__ ((visibility ("default")))
 Marks functions that are provided for use by the library.
 
#define STUMPLESS_CHAIN_TARGET_ARRAY_LENGTH   4
 The length of the array in the chain target structure.
 
#define STUMPLESS_DEFAULT_FACILITY   STUMPLESS_FACILITY_USER
 The facility code to use when one is not supplied.
 
#define STUMPLESS_DEFAULT_FILE   "stumpless-default.log"
 The name of the file opened if the default target is to a file.
 
#define STUMPLESS_DEFAULT_SEVERITY   STUMPLESS_SEVERITY_INFO
 The severity code to use when one is not supplied.
 
#define STUMPLESS_DEFAULT_SOCKET   "/dev/log"
 A string literal with the default socket logged to.
 
#define STUMPLESS_FALLBACK_PAGESIZE   4096
 The memory page size used for dynamic memory allocations.
 
#define STUMPLESS_LANGUAGE   "en-US"
 The language stumpless was built for, as an RFC 5646 language tag.
 
#define STUMPLESS_CHAIN_TARGETS_SUPPORTED   1
 Defined if chain targets are supported by this build.
 
#define STUMPLESS_JOURNALD_TARGETS_SUPPORTED   1
 Defined if journald targets are supported by this build.
 
#define STUMPLESS_NETWORK_TARGETS_SUPPORTED   1
 Defined if network targets are supported by this build.
 
#define STUMPLESS_SOCKET_TARGETS_SUPPORTED   1
 Defined if socket targets are supported by this build.
 
#define STUMPLESS_DEFAULT_SQLITE3_TABLE_NAME_STRING   "logs"
 A string literal with the name of the table used by default for SQLite3 targets.
 
#define STUMPLESS_SQLITE3_RETRY_MAX   3
 The maximum number of retries for SQLite operations.
 
#define STUMPLESS_SQLITE3_TARGETS_SUPPORTED   1
 Defined if sqlite3 targets are supported by this build.
 
#define STUMPLESS_SYSLOG_H_COMPATIBLE   1
 Defined if this build can directly replace syslog.h usage.
 
#define STUMPLESS_THREAD_SAFETY_SUPPORTED   1
 Defined if thread-safe functionality is supported.
 
#define STUMPLESS_WINDOWS_EVENT_LOG_TARGETS_SUPPORTED   1
 Defined if Windows Event Log targets are supported by this build.
 
#define STUMPLESS_DEPRECATION_WARNINGS_ENABLED   1
 Defined if deprecation warnings are printed to standard output.
 
#define STUMPLESS_MAJOR_VERSION   2
 The major version of this stumpless build.
 
#define STUMPLESS_MINOR_VERSION   2
 The minor version of this stumpless build.
 
#define STUMPLESS_PATCH_VERSION   0
 The patch version of this stumpless build.
 
#define STUMPLESS_VERSION   "2.2.0"
 The version of stumpless this library was built with.
 

Detailed Description

Configuration information to provide to code built with the library.

Macro Definition Documentation

◆ STUMPLESS_CHAIN_TARGET_ARRAY_LENGTH

#define STUMPLESS_CHAIN_TARGET_ARRAY_LENGTH   4

The length of the array in the chain target structure.

Chains where all targets fit into this array will require less dynamic memory and fewer dereferences, speeding up their performance.

Since
release v2.2.0

◆ STUMPLESS_CHAIN_TARGETS_SUPPORTED

#define STUMPLESS_CHAIN_TARGETS_SUPPORTED   1

Defined if chain targets are supported by this build.

◆ STUMPLESS_DEFAULT_FACILITY

#define STUMPLESS_DEFAULT_FACILITY   STUMPLESS_FACILITY_USER

The facility code to use when one is not supplied.

◆ STUMPLESS_DEFAULT_FILE

#define STUMPLESS_DEFAULT_FILE   "stumpless-default.log"

The name of the file opened if the default target is to a file.

◆ STUMPLESS_DEFAULT_SEVERITY

#define STUMPLESS_DEFAULT_SEVERITY   STUMPLESS_SEVERITY_INFO

The severity code to use when one is not supplied.

◆ STUMPLESS_DEFAULT_SOCKET

#define STUMPLESS_DEFAULT_SOCKET   "/dev/log"

A string literal with the default socket logged to.

◆ STUMPLESS_DEFAULT_SQLITE3_TABLE_NAME_STRING

#define STUMPLESS_DEFAULT_SQLITE3_TABLE_NAME_STRING   "logs"

A string literal with the name of the table used by default for SQLite3 targets.

Since
release v2.2.0

◆ STUMPLESS_DEPRECATION_WARNINGS_ENABLED

#define STUMPLESS_DEPRECATION_WARNINGS_ENABLED   1

Defined if deprecation warnings are printed to standard output.

◆ STUMPLESS_FALLBACK_PAGESIZE

#define STUMPLESS_FALLBACK_PAGESIZE   4096

The memory page size used for dynamic memory allocations.

◆ STUMPLESS_JOURNALD_TARGETS_SUPPORTED

#define STUMPLESS_JOURNALD_TARGETS_SUPPORTED   1

Defined if journald targets are supported by this build.

◆ STUMPLESS_LANGUAGE

#define STUMPLESS_LANGUAGE   "en-US"

The language stumpless was built for, as an RFC 5646 language tag.

◆ STUMPLESS_MAJOR_VERSION

#define STUMPLESS_MAJOR_VERSION   2

The major version of this stumpless build.

◆ STUMPLESS_MINOR_VERSION

#define STUMPLESS_MINOR_VERSION   2

The minor version of this stumpless build.

◆ STUMPLESS_NETWORK_TARGETS_SUPPORTED

#define STUMPLESS_NETWORK_TARGETS_SUPPORTED   1

Defined if network targets are supported by this build.

◆ STUMPLESS_PATCH_VERSION

#define STUMPLESS_PATCH_VERSION   0

The patch version of this stumpless build.

◆ STUMPLESS_PUBLIC_FUNCTION

#define STUMPLESS_PUBLIC_FUNCTION   __attribute__ ((visibility ("default")))

Marks functions that are provided for use by the library.

◆ STUMPLESS_SOCKET_TARGETS_SUPPORTED

#define STUMPLESS_SOCKET_TARGETS_SUPPORTED   1

Defined if socket targets are supported by this build.

◆ STUMPLESS_SQLITE3_RETRY_MAX

#define STUMPLESS_SQLITE3_RETRY_MAX   3

The maximum number of retries for SQLite operations.

Since
release v2.2.0

◆ STUMPLESS_SQLITE3_TARGETS_SUPPORTED

#define STUMPLESS_SQLITE3_TARGETS_SUPPORTED   1

Defined if sqlite3 targets are supported by this build.

◆ STUMPLESS_SYSLOG_H_COMPATIBLE

#define STUMPLESS_SYSLOG_H_COMPATIBLE   1

Defined if this build can directly replace syslog.h usage.

◆ STUMPLESS_THREAD_SAFETY_SUPPORTED

#define STUMPLESS_THREAD_SAFETY_SUPPORTED   1

Defined if thread-safe functionality is supported.

◆ STUMPLESS_VERSION

#define STUMPLESS_VERSION   "2.2.0"

The version of stumpless this library was built with.

This will be in standard semantic versioning format: 'major.minor.patch'.

◆ STUMPLESS_WINDOWS_EVENT_LOG_TARGETS_SUPPORTED

#define STUMPLESS_WINDOWS_EVENT_LOG_TARGETS_SUPPORTED   1

Defined if Windows Event Log targets are supported by this build.