From 8405efef94a1edcd4d58e6053d17d4dc0e1fcd26 Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Mon, 14 Oct 2024 22:59:45 -0700 Subject: log documentation converted to mdbook. --- docs/ref/api/log/nng_log_level.md | 43 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 docs/ref/api/log/nng_log_level.md (limited to 'docs/ref/api/log/nng_log_level.md') diff --git a/docs/ref/api/log/nng_log_level.md b/docs/ref/api/log/nng_log_level.md new file mode 100644 index 00000000..a875a7e0 --- /dev/null +++ b/docs/ref/api/log/nng_log_level.md @@ -0,0 +1,43 @@ +# nng_log_level + +## NAME + +nng_log_level --- severity level for logging messages + +## SYNOPSIS + +```c +#include + +typedef enum nng_log_level { + NNG_LOG_NONE = 0, // used for filters only, NNG suppresses these + NNG_LOG_ERR = 3, + NNG_LOG_WARN = 4, + NNG_LOG_NOTICE = 5, + NNG_LOG_INFO = 6, + NNG_LOG_DEBUG = 7 +} nng_log_level; + +void nng_log_set_level(nng_log_level level); +nng_log_level nng_log_get_level(void); +``` + +## DESCRIPTION + +The `nng_log_level` type represents a severity for logged messages. +These levels correspond to those found in the UNIX `syslog` subsystem, +although applications should not depend upon the values being identical. + +The `nng_log_set_level` function is used to set the minimum severity to _level_ for processing log messages. +Any messages with a less severe rating are not processed and simply are discarded. +Use `NNG_LOG_NONE` to suppress all log messages. +Use `NNG_LOG_DEBUG` to receive all log messages. + +The `nng_log_get_level` function returns the current log level, which can be useful +to elide processing to create log content that will simply be discarded anyway. + +## SEE ALSO + +[nng_log](./nng_log.md), +[nng_log_facility](./nng_log_facility.md), +[nng_log_logger](./nng_log_logger.md) -- cgit v1.2.3-70-g09d2