diff options
| author | Garrett D'Amore <garrett@damore.org> | 2024-10-14 22:59:45 -0700 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2024-10-14 22:59:45 -0700 |
| commit | 8405efef94a1edcd4d58e6053d17d4dc0e1fcd26 (patch) | |
| tree | e5702fb571ac39482ffa0d671db29e12ff3d9750 /docs/ref/api/log/nng_log_facility.md | |
| parent | e8d6c2bf692dbcb4c503caa676314a6a626a8a68 (diff) | |
| download | nng-8405efef94a1edcd4d58e6053d17d4dc0e1fcd26.tar.gz nng-8405efef94a1edcd4d58e6053d17d4dc0e1fcd26.tar.bz2 nng-8405efef94a1edcd4d58e6053d17d4dc0e1fcd26.zip | |
log documentation converted to mdbook.
Diffstat (limited to 'docs/ref/api/log/nng_log_facility.md')
| -rw-r--r-- | docs/ref/api/log/nng_log_facility.md | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/docs/ref/api/log/nng_log_facility.md b/docs/ref/api/log/nng_log_facility.md new file mode 100644 index 00000000..28ffd05f --- /dev/null +++ b/docs/ref/api/log/nng_log_facility.md @@ -0,0 +1,47 @@ +# 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) |
