diff options
Diffstat (limited to 'src/lib/buf')
| -rw-r--r-- | src/lib/buf/lib_buf.dox | 13 |
1 files changed, 12 insertions, 1 deletions
diff --git a/src/lib/buf/lib_buf.dox b/src/lib/buf/lib_buf.dox index 9caaba07f0..a2ac23ee4c 100644 --- a/src/lib/buf/lib_buf.dox +++ b/src/lib/buf/lib_buf.dox @@ -1,4 +1,15 @@ /** @dir /lib/buf -@brief lib/buf +@brief lib/buf: An efficient byte queue. + +This module defines the buf_t type, which is used throughout our networking +code. The implementation is a singly-linked queue of buffer chunks, similar +to the BSD kernel's +["mbuf"](https://www.freebsd.org/cgi/man.cgi?query=mbuf&sektion=9) structure. + +The buf_t type is also reasonable for use in constructing long strings. + +See \refdir{lib/net} for networking code that uses buf_t, and +\refdir{lib/tls} for cryptographic code that uses buf_t. + **/ |