aboutsummaryrefslogtreecommitdiff
path: root/docs/ref/api/log/nng_log_level.md
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2024-10-19 12:48:12 -0700
committerGarrett D'Amore <garrett@damore.org>2024-10-19 12:48:12 -0700
commit663d83b6bf5171824ef6f3ae76bb108c27ddf4ed (patch)
tree5a0f339e152ae88348df70421aff3930e8d8025a /docs/ref/api/log/nng_log_level.md
parent8f42f78490fd14b2e6d46d09ec395fbdad5495ce (diff)
downloadnng-663d83b6bf5171824ef6f3ae76bb108c27ddf4ed.tar.gz
nng-663d83b6bf5171824ef6f3ae76bb108c27ddf4ed.tar.bz2
nng-663d83b6bf5171824ef6f3ae76bb108c27ddf4ed.zip
Logging as a single chapter.
This is the direction we want to go with documentation. Major areas of functionality should be one single chapter in the API reference, which should make them far more usable for people not already familiar with NNG. This represents a substantial departure from UNIX man pages, but many of our users are not used to working with UNIX man pages anyway, and organization of man pages, while convenient for reading with the legacy shell man command, fails on a number of usability fronts.
Diffstat (limited to 'docs/ref/api/log/nng_log_level.md')
-rw-r--r--docs/ref/api/log/nng_log_level.md47
1 files changed, 0 insertions, 47 deletions
diff --git a/docs/ref/api/log/nng_log_level.md b/docs/ref/api/log/nng_log_level.md
deleted file mode 100644
index 7e7cadb2..00000000
--- a/docs/ref/api/log/nng_log_level.md
+++ /dev/null
@@ -1,47 +0,0 @@
-# nng_log_level
-
-## NAME
-
-nng_log_level --- severity level for logging messages
-
-## SYNOPSIS
-
-```c
-#include <nng/nng.h>
-
-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.
-
-## RETURN VALUES
-
-The `nng_log_get_level` functions returns the current log level.
-
-## SEE ALSO
-
-[nng_log](./nng_log.md),
-[nng_log_facility](./nng_log_facility.md),
-[nng_log_logger](./nng_log_logger.md)