stumpless Namespace Reference

Classes
class	AddressFailure
	A provided network address was not valid. More...
class	ArgumentEmpty
	A required function parameter was NULL or empty. More...
class	ArgumentTooBig
	A provided argument was too big, for example to fit into a buffer target. More...
class	BufferTarget
	A target that will write log messages to a provided buffer, wrapping around when the end is reached. More...
class	ChainTarget
	A target allowing entries to be sent to a sequence of targets. More...
class	DuplicateElement
	A duplicate of an already existing element was detected in an Entry. More...
class	Element
	An element of structured data. More...
class	ElementNotFound
	No element with the specified characteristics was found. More...
class	Entry
	A log entry. More...
class	FileOpenFailure
	Could not open a file. More...
class	FileTarget
	A target allowing logs to be written to a given file. More...
class	FileWriteFailure
	Could not write to a file. More...
class	FunctionTarget
	A target allowing entries to be sent to a custom function. More...
class	FunctionTargetFailure
	A call to a function target's log function failed. More...
class	IndexOutOfBounds
	A provided index was not in a valid range. More...
class	InvalidFacility
	A provided facility code did not conform to RFC 5424. More...
class	InvalidId
	A target or entry ID was not valid. More...
class	InvalidSeverity
	A provided severity code did not conform to RFC 5424. More...
class	MemoryAllocationFailure
	A memory allocation or reallocation failed. More...
class	MemoryManager
	Container for memory management functions in Stumpless. More...
class	NetworkProtocolUnsupported
	The given layer 3 protocol is not supported by this implementation. More...
class	NetworkTarget
	Network targets allow traditional syslog messages to be sent to a remote server. More...
class	Param
	A parameter within a structured data element. More...
class	ParamNotFound
	No param with the specified characteristics was found. More...
class	SocketBindFailure
	Could not bind to a socket. More...
class	SocketConnectFailure
	Could not connect to a socket. More...
class	SocketFailure
	Could not create a socket. More...
class	SocketSendFailure
	Could not send to a socket. More...
class	SocketTarget
	Socket targets allow logs to be sent to a Unix domain socket, like the frequently used /dev/log or /var/run/syslog sockets associated with syslog daemons. More...
class	Sqlite3Target
class	StreamTarget
	A target that will write log messages to a provided I/O stream. More...
class	StreamWriteFailure
	Could not write to a stream. More...
class	StumplessException
	A general problem has been encountered by the library. More...
class	TargetIncompatible
	The requested operation is not valid on the given target type. More...
class	TargetUnsupported
	The target type provided is unsupported by this implementation. More...
class	TransportProtocolUnsupported
	The given layer 4 protocol is not supported by this implementation. More...
class	Version
	Describes this version of Stumpless. More...
class	WindowsEventLogCloseFailure
	Could not close the Windows Event Log. More...
class	WindowsEventLogOpenFailure
	Could not open the Windows Event Log. More...

Enumerations
enum class	ErrorId {   ADDRESS_FAILURE = STUMPLESS_ADDRESS_FAILURE , ARGUMENT_EMPTY = STUMPLESS_ARGUMENT_EMPTY , ARGUMENT_TOO_BIG = STUMPLESS_ARGUMENT_TOO_BIG , DUPLICATE_ELEMENT = STUMPLESS_DUPLICATE_ELEMENT ,   ELEMENT_NOT_FOUND = STUMPLESS_ELEMENT_NOT_FOUND , FILE_OPEN_FAILURE = STUMPLESS_FILE_OPEN_FAILURE , FILE_WRITE_FAILURE = STUMPLESS_FILE_WRITE_FAILURE , FUNCTION_TARGET_FAILURE = STUMPLESS_FUNCTION_TARGET_FAILURE ,   INDEX_OUT_OF_BOUNDS = STUMPLESS_INDEX_OUT_OF_BOUNDS , INVALID_FACILITY = STUMPLESS_INVALID_FACILITY , INVALID_ID = STUMPLESS_INVALID_ID , INVALID_SEVERITY = STUMPLESS_INVALID_SEVERITY ,   MEMORY_ALLOCATION_FAILURE = STUMPLESS_MEMORY_ALLOCATION_FAILURE , NETWORK_PROTOCOL_UNSUPPORTED = STUMPLESS_NETWORK_PROTOCOL_UNSUPPORTED , PARAM_NOT_FOUND = STUMPLESS_SOCKET_BIND_FAILURE , SOCKET_CONNECT_FAILURE = STUMPLESS_SOCKET_CONNECT_FAILURE ,   SOCKET_FAILURE = STUMPLESS_SOCKET_FAILURE , SOCKET_SEND_FAILURE = STUMPLESS_SOCKET_SEND_FAILURE , STREAM_WRITE_FAILURE = STUMPLESS_STREAM_WRITE_FAILURE , TARGET_INCOMPATIBLE = STUMPLESS_TARGET_INCOMPATIBLE ,   TARGET_UNSUPPORTED = STUMPLESS_TARGET_UNSUPPORTED , TRANSPORT_PROTOCOL_UNSUPPORTED = STUMPLESS_TRANSPORT_PROTOCOL_UNSUPPORTED , WINDOWS_EVENT_LOG_CLOSE_FAILURE = STUMPLESS_WINDOWS_EVENT_LOG_CLOSE_FAILURE , WINDOWS_EVENT_LOG_OPEN_FAILURE = STUMPLESS_WINDOWS_EVENT_LOG_OPEN_FAILURE }
	Unique identifiers for library errors. More...
enum class	Facility {   KERNEL = STUMPLESS_FACILITY_KERN , USER = STUMPLESS_FACILITY_USER , MAIL = STUMPLESS_FACILITY_MAIL , DAEMON = STUMPLESS_FACILITY_DAEMON ,   AUTH = STUMPLESS_FACILITY_AUTH , SYSLOG = STUMPLESS_FACILITY_SYSLOG , LINE_PRINTER = STUMPLESS_FACILITY_LPR , NEWS = STUMPLESS_FACILITY_NEWS ,   UUCP = STUMPLESS_FACILITY_UUCP , CRON = STUMPLESS_FACILITY_CRON , AUTH2 = STUMPLESS_FACILITY_AUTH2 , FTP = STUMPLESS_FACILITY_FTP ,   NTP = STUMPLESS_FACILITY_NTP , AUDIT = STUMPLESS_FACILITY_AUDIT , ALERT = STUMPLESS_FACILITY_ALERT , CRON2 = STUMPLESS_FACILITY_CRON2 ,   LOCAL_0 = STUMPLESS_FACILITY_LOCAL0 , LOCAL_1 = STUMPLESS_FACILITY_LOCAL1 , LOCAL_2 = STUMPLESS_FACILITY_LOCAL2 , LOCAL_3 = STUMPLESS_FACILITY_LOCAL3 ,   LOCAL_4 = STUMPLESS_FACILITY_LOCAL4 , LOCAL_5 = STUMPLESS_FACILITY_LOCAL5 , LOCAL_6 = STUMPLESS_FACILITY_LOCAL6 , LOCAL_7 = STUMPLESS_FACILITY_LOCAL7 }
	Facilities (as defined in RFC 5424) describe the general classification of an event. More...
enum class	NetworkProtocol { IPV4 = STUMPLESS_IPV4_NETWORK_PROTOCOL , IPV6 = STUMPLESS_IPV6_NETWORK_PROTOCOL }
	Network protocols used by network targets. More...
enum class	Severity {   EMERGENCY = STUMPLESS_SEVERITY_EMERG , ALERT = STUMPLESS_SEVERITY_ALERT , CRITICAL = STUMPLESS_SEVERITY_CRIT , ERR = STUMPLESS_SEVERITY_ERR ,   WARNING = STUMPLESS_SEVERITY_WARNING , NOTICE = STUMPLESS_SEVERITY_NOTICE , INFO = STUMPLESS_SEVERITY_INFO , DEBUG = STUMPLESS_SEVERITY_DEBUG }
	Severities (as defined in RFC 5424) describe the level of importance of a given log entry. More...
enum class	TransportProtocol { TCP = STUMPLESS_TCP_TRANSPORT_PROTOCOL , UDP = STUMPLESS_UDP_TRANSPORT_PROTOCOL }
	Transport protocols used by network targets. More...

Enumeration Type Documentation

ErrorId

enum class stumpless::ErrorId

strong

Unique identifiers for library errors.

Enumerator
ADDRESS_FAILURE	A provided network address was not valid. This might be formatting problem, or it might mean that a DNS lookup failed.
ARGUMENT_EMPTY	A required function parameter was NULL or empty.
ARGUMENT_TOO_BIG	A provided argument was too big, for example to fit into a buffer target.
DUPLICATE_ELEMENT	A duplicate of an already existing element was detected in an Entry.
ELEMENT_NOT_FOUND	No element with the specified characteristics was found.
FILE_OPEN_FAILURE	Could not open a file.
FILE_WRITE_FAILURE	Could not write to a file.
FUNCTION_TARGET_FAILURE	A call to a function target's log function failed.
INDEX_OUT_OF_BOUNDS	A provided index was not in a valid range.
INVALID_FACILITY	A provided facility code did not conform to RFC 5424.
INVALID_ID	A target or entry ID was not valid.
INVALID_SEVERITY	A provided severity code did not conform to RFC 5424.
MEMORY_ALLOCATION_FAILURE	A memory allocation or reallocation failed.
NETWORK_PROTOCOL_UNSUPPORTED	The given layer 3 protocol is not supported by this implementation.
PARAM_NOT_FOUND	Could not bind to a socket.
SOCKET_CONNECT_FAILURE	Could not connect to a socket.
SOCKET_FAILURE	Could not create a socket.
SOCKET_SEND_FAILURE	Could not send to a socket.
STREAM_WRITE_FAILURE	Could not write to a stream.
TARGET_INCOMPATIBLE	The requested operation is not valid on the given target type.
TARGET_UNSUPPORTED	The target type provided is unsupported by this implementation.
TRANSPORT_PROTOCOL_UNSUPPORTED	The given layer 4 protocol is not supported by this implementation.
WINDOWS_EVENT_LOG_CLOSE_FAILURE	Could not close the Windows Event Log.
WINDOWS_EVENT_LOG_OPEN_FAILURE	Could not open the Windows Event Log.

Facility

enum class stumpless::Facility

strong

Facilities (as defined in RFC 5424) describe the general classification of an event.

While they may not apply in every situation, they provide a general starting point for categorization. The underlying values of this enumeration will match those provided in syslog.h if it was available during build, and if there is matching value in the standard. Check for the definition of STUMPLESS_SYSLOG_H_COMPATIBLE to see if you can rely on this behavior.

Enumerator
KERNEL	Kernel messages.
USER	User-level messages.
MAIL	Mail system.
DAEMON	System daemons.
AUTH	Security/authorization messages.
SYSLOG	Messages generated internally by logging daemon.
LINE_PRINTER	Line printer subsystem.
NEWS	Network news subsystem.
UUCP	Unix to Unix Copy subsystem.
CRON	Clock daemon.
AUTH2	Security/authorization messages.
FTP	FTP daemon.
NTP	NTP subsystem.
AUDIT	Log audit.
ALERT	Log alert.
CRON2	Clock daemon.
LOCAL_0	Local use 0.
LOCAL_1	Local use 1.
LOCAL_2	Local use 2.
LOCAL_3	Local use 3.
LOCAL_4	Local use 4.
LOCAL_5	Local use 5.
LOCAL_6	Local use 6.
LOCAL_7	Local use 7.

NetworkProtocol

enum class stumpless::NetworkProtocol

strong

Network protocols used by network targets.

Enumerator
IPV4	Internet Protocol version 4, RFC 791.
IPV6	Internet Protocl version 6, RFC 8200.

Severity

enum class stumpless::Severity

strong

Severities (as defined in RFC 5424) describe the level of importance of a given log entry.

They range from extremely important to ignorable. The underlying values of this enumeration will match those provided in syslog.h if it was available during build. Check for the definition of STUMPLESS_SYSLOG_H_COMPATIBLE to see if you can rely on this behavior.

Enumerator
EMERGENCY	System is unusable.
ALERT	Action must be taken immediately.
CRITICAL	Critical conditions.
ERR	Error conditions.
WARNING	Warning conditions.
NOTICE	Normal but significant conditions.
INFO	Informational messages.
DEBUG	Debug-level messages.

TransportProtocol

enum class stumpless::TransportProtocol

strong

Transport protocols used by network targets.

Enumerator
TCP	TCP, RFC 793.
UDP	UDP, RFC 768.