diff options
| author | Nick Mathewson <nickm@torproject.org> | 2019-11-04 11:51:38 -0500 |
|---|---|---|
| committer | Nick Mathewson <nickm@torproject.org> | 2019-11-04 11:51:38 -0500 |
| commit | 76e8effc7b8e747cd34188a5a27e6d792a66ba7e (patch) | |
| tree | 4f860630375bbed2e613f61c2c4473303be5451e /src/lib/buf | |
| parent | fd271363296b89cb3a11e97e507546b3600fde59 (diff) | |
| download | tor-76e8effc7b8e747cd34188a5a27e6d792a66ba7e.tar.gz tor-76e8effc7b8e747cd34188a5a27e6d792a66ba7e.zip | |
Doxygen: document the rest of the directories in lib.
(This copies documentation from doc/HACKING/design, and edits for
concisensess and clarity.)
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. + **/ |