aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nng_log_set_level.adoc
diff options
context:
space:
mode:
Diffstat (limited to 'docs/man/nng_log_set_level.adoc')
-rw-r--r--docs/man/nng_log_set_level.adoc42
1 files changed, 42 insertions, 0 deletions
diff --git a/docs/man/nng_log_set_level.adoc b/docs/man/nng_log_set_level.adoc
new file mode 100644
index 00000000..012f93f8
--- /dev/null
+++ b/docs/man/nng_log_set_level.adoc
@@ -0,0 +1,42 @@
+= nng_log_set_level(3)
+//
+// Copyright 2024 Staysail Systems, Inc. <info@staysail.tech>
+//
+// This document is supplied under the terms of the MIT License, a
+// copy of which should be located in the distribution where this
+// file was obtained (LICENSE.txt). A copy of the license may also be
+// found online at https://opensource.org/licenses/MIT.
+//
+
+== NAME
+
+nng_log_set_level - set minimum level for logging messagse
+
+== SYNOPSIS
+
+[source, 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);
+----
+
+== DESCRIPTION
+
+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.
+
+== SEE ALSO
+
+xref:nng_log_set_facility.3.adoc[nng_log_set_facility(3)]