v2-2-0/en-US/stumpless_8h_source.html

/* SPDX-License-Identifier: Apache-2.0 */


/*

 * Copyright 2018-2024 Joel E. Anderson

 *

 * Licensed under the Apache License, Version 2.0 (the "License");

 * you may not use this file except in compliance with the License.

 * You may obtain a copy of the License at

 *

 *     http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,

 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License.

 */


#ifndef __STUMPLESS_H

#define __STUMPLESS_H


#include <stumpless/config.h>

#include <stumpless/element.h>

#include <stumpless/entry.h>

#include <stumpless/error.h>

#include <stumpless/facility.h>

#include <stumpless/filter.h>

#include <stumpless/generator.h>

#include <stumpless/id.h>

#include <stumpless/level/alert.h>

#include <stumpless/level/crit.h>

#include <stumpless/level/debug.h>

#include <stumpless/level/emerg.h>

#include <stumpless/level/err.h>

#include <stumpless/level/info.h>

#include <stumpless/level/notice.h>

#include <stumpless/level/trace.h>

#include <stumpless/level/warning.h>

#include <stumpless/log.h>

#include <stumpless/memory.h>

#include <stumpless/option.h>

#include <stumpless/param.h>

#include <stumpless/severity.h>

#include <stumpless/target.h>

#include <stumpless/target/buffer.h>

#include <stumpless/target/file.h>

#include <stumpless/target/function.h>

#include <stumpless/target/sqlite3.h>

#include <stumpless/target/stream.h>

#include <stumpless/version.h>

#include <stumpless/priority.h>

#include <stumpless/prival.h>


#ifdef STUMPLESS_CHAIN_TARGETS_SUPPORTED

#  include <stumpless/target/chain.h>

#endif


#ifdef STUMPLESS_JOURNALD_TARGETS_SUPPORTED

#  include <stumpless/config/journald_supported.h>

#  include <stumpless/target/journald.h>

#endif


#ifdef STUMPLESS_NETWORK_TARGETS_SUPPORTED

#  include <stumpless/target/network.h>

#endif


#ifdef STUMPLESS_SOCKET_TARGETS_SUPPORTED

#  include <stumpless/target/socket.h>

#endif


#ifdef STUMPLESS_SQLITE3_TARGETS_SUPPORTED

#endif


#ifdef STUMPLESS_WINDOWS_EVENT_LOG_TARGETS_SUPPORTED

#  include <stumpless/config/wel_supported.h>

#  include <stumpless/target/wel.h>

#  include <stumpless/windows/default_events.h>

#endif


#endif /* __STUMPLESS_H */

alert.h
Macro functions that log messages and entries at the alert level.

buffer.h
Buffer targets provide the simple capability to write logs into a character buffer.

chain.h
Chains allow logs to be sent to a group of targets.

config.h
Configuration information to provide to code built with the library.

crit.h
Macro functions that log messages and entries at the crit level.

debug.h
Macro functions that log messages and entries at the debug level.

element.h
Types and functions for creating and modifying elements.

emerg.h
Macro functions that log messages and entries at the emerg level.

entry.h
Types and functions for creating and modifying entries.

err.h
Macro functions that log messages and entries at the err level.

error.h
Error codes and functions for detecting and assessing them.

facility.h
Facility codes for classifying log entries.

file.h
File targets allow logs to be sent to a specified file.

filter.h
Filters that can be used to control which entries are sent to targets at runtime.

function.h
Function targets allow log entries to be sent to a custom function, making it possible to implement a...

generator.h
Generic functionality to be used with STUMPLESS_FOREACH macros to allow for more generic definition o...

id.h
The identification for targets within the library.

info.h
Macro functions that log messages and entries at the info level.

journald.h
Journald targets send messages to a systemd journald service.

journald_supported.h
Functions that help when using journald targets.

log.h
Convenience functions for creating and writing simple log entries.

memory.h
Functions for controlling memory allocation during execution.

network.h
Network targets allow logs to be sent over a network to a remote log collector or relay.

notice.h
Macro functions that log messages and entries at the notice level.

option.h
Options that can be used to modify the behavior of Stumpless components.

param.h
Types and functions for creating and modifying params.

priority.h
Priority value (PRIVAL) represents both the Facility and Severity values.

prival.h
Functions for working with privals.

severity.h
Severity codes for classifying log entries.

socket.h
Socket targets allow logs to be sent to a Unix domain socket.

sqlite3.h
SQLite3 targets allow logs to be sent to a SQLite3 database.

stream.h
Functions for working with stream targets (that is, FILE pointers).

target.h
General types and functions for working with all targets.

trace.h
Macro functions that log messages and entries for source tracing.

version.h
Runtime information about the library.

warning.h
Macro functions that log messages and entries at the warning level.

wel.h
Functions for working with Windows Event Log (WEL) targets.

wel_supported.h
Functions necessary when using Windows Event Log targets.