aboutsummaryrefslogtreecommitdiff
path: root/docs/ref/api/log/nng_log_level.md
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2024-10-14 22:59:45 -0700
committerGarrett D'Amore <garrett@damore.org>2024-10-14 22:59:45 -0700
commit8405efef94a1edcd4d58e6053d17d4dc0e1fcd26 (patch)
treee5702fb571ac39482ffa0d671db29e12ff3d9750 /docs/ref/api/log/nng_log_level.md
parente8d6c2bf692dbcb4c503caa676314a6a626a8a68 (diff)
downloadnng-8405efef94a1edcd4d58e6053d17d4dc0e1fcd26.tar.gz
nng-8405efef94a1edcd4d58e6053d17d4dc0e1fcd26.tar.bz2
nng-8405efef94a1edcd4d58e6053d17d4dc0e1fcd26.zip
log documentation converted to mdbook.
Diffstat (limited to 'docs/ref/api/log/nng_log_level.md')
-rw-r--r--docs/ref/api/log/nng_log_level.md43
1 files changed, 43 insertions, 0 deletions
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 <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.
+
+## SEE ALSO
+
+[nng_log](./nng_log.md),
+[nng_log_facility](./nng_log_facility.md),
+[nng_log_logger](./nng_log_logger.md)