aboutsummaryrefslogtreecommitdiff
path: root/docs/ref/api/log/nng_log_facility.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_facility.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_facility.md')
-rw-r--r--docs/ref/api/log/nng_log_facility.md47
1 files changed, 0 insertions, 47 deletions
diff --git a/docs/ref/api/log/nng_log_facility.md b/docs/ref/api/log/nng_log_facility.md
deleted file mode 100644
index 28ffd05f..00000000
--- a/docs/ref/api/log/nng_log_facility.md
+++ /dev/null
@@ -1,47 +0,0 @@
-# nng_log_facility
-
-## NAME
-
-nng_log_facility --- facility or category for log messages
-
-## SYNOPSIS
-
-```c
-#include <nng/nng.h>
-
-typedef enum nng_log_facility {
- NNG_LOG_USER = 1,
- NNG_LOG_DAEMON = 3,
- NNG_LOG_AUTH = 10,
- NNG_LOG_LOCAL0 = 16,
- NNG_LOG_LOCAL1 = 17,
- NNG_LOG_LOCAL2 = 18,
- NNG_LOG_LOCAL3 = 19,
- NNG_LOG_LOCAL4 = 20,
- NNG_LOG_LOCAL5 = 21,
- NNG_LOG_LOCAL6 = 22,
- NNG_LOG_LOCAL7 = 23,
-} nng_log_facility;
-
-void nng_log_set_facility(nng_log_facility facility);
-```
-
-## DESCRIPTION
-
-An {{i:`nng_log_facility`}} object represents a facility, which can be thought of as
-a category, for log message. Normally these are used to identify the source of the
-message. The facility values here correspond to those typical used with the UNIX
-`syslog` logging system.
-
-The `nng_log_set_facility` is used to set the _facility_ of the application posting logs,
-so that messages that are submitted by the application can be correctly attributed to
-the application itself. It may also help in message routing.
-
-Note that while the log levels used here overlap with common levels used by the
-`syslog` system found on POSIX systems, applications should not the numeric values
-being the same.
-
-## SEE ALSO
-
-[nng_log](./nng_log.md),
-[nng_log_level](./nng_log_level.md)