Skip to content

Commit

Permalink
Add syslog RFCs to see also
Browse files Browse the repository at this point in the history
  • Loading branch information
gdamore committed Oct 19, 2024
1 parent 663d83b commit faea593
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 1 deletion.
15 changes: 14 additions & 1 deletion docs/ref/api/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,20 @@
# API Reference

This section is a reference guide for the NNG programming interfaces.
This section is a reference guide for the _NNG_ programming interfaces.
It is meant to serve as a refernce, rather than as a tutorial.

The material here is organized by major areas of functionality.

Note that unless indicated otherwise, consumers of these interfaces must
include the `nng/nng.h` header file like so:

```c
#include <nng/nng.h>
```

## Chapters

- [Messages](msg/)
- [Threading and Synchronization](thr/)
- [Logging](logging.md)
- [Utility Functions](util/)
10 changes: 10 additions & 0 deletions docs/ref/api/logging.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,16 @@ The {{i:`nng_system_logger`}} attempts to use an appropriate system facility to
For POSIX systems, this means using `syslog` to process the messages.
For other systems the defauilt behavior may be the same as `nng_stderr_logger`.
## See Also
The Syslog Protocol upon which this is based is documented in the following two IETF
RFCS,
- R. Gerhards, [RFC 5424](https://datatracker.ietf.org/doc/html/rfc5424), _The Syslog Protocol_,
March 2009
- C. Lonvick, [RFC 3164](https://datatracker.ietf.org/doc/html/rfc3164), _The BSD syslog Protocol_,
August 2001
[log_level]: #log-levels
[log_facility]: #log-facilities
[log_logger]: #log-handlers
Expand Down

0 comments on commit faea593

Please sign in to comment.