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/pubsub | |
| 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/pubsub')
| -rw-r--r-- | src/lib/pubsub/lib_pubsub.dox | 14 |
1 files changed, 13 insertions, 1 deletions
diff --git a/src/lib/pubsub/lib_pubsub.dox b/src/lib/pubsub/lib_pubsub.dox index 3fd026cc09..c033660121 100644 --- a/src/lib/pubsub/lib_pubsub.dox +++ b/src/lib/pubsub/lib_pubsub.dox @@ -1,4 +1,16 @@ /** @dir /lib/pubsub -@brief lib/pubsub +@brief lib/pubsub: Publish-subscribe message passing. + +This module wraps the \refdir{lib/dispatch} module, to provide a more +ergonomic and type-safe approach to message passing. + +In general, we favor this mechanism for cases where higher-level modules +need to be notified when something happens in lower-level modules. (The +alternative would be calling up from the lower-level modules, which +would be error-prone; or maintaining lists of function-pointers, which +would be clumsy and tend to complicate the call graph.) + +See pubsub.c for more information. + **/ |