diff options
| author | Nick Mathewson <nickm@torproject.org> | 2019-11-04 10:19:41 -0500 |
|---|---|---|
| committer | Nick Mathewson <nickm@torproject.org> | 2019-11-04 10:21:10 -0500 |
| commit | 51a98929148e9ca08b33735fb0542759380c57a9 (patch) | |
| tree | 96951d1d564d4ac379e9feba4a28807c2855e875 /src/lib/dispatch/lib_dispatch.dox | |
| parent | b6b125709998a81d9c9c23d77c6a770ca7a927a7 (diff) | |
| download | tor-51a98929148e9ca08b33735fb0542759380c57a9.tar.gz tor-51a98929148e9ca08b33735fb0542759380c57a9.zip | |
doxygen: Take "lib" descriptions from doc/HACKING/design.
This commit takes descriptions for src/lib and moves them into our
doxygen hierarchy. I've covered everything from lib/cc through
lib/sandbox here.
Diffstat (limited to 'src/lib/dispatch/lib_dispatch.dox')
| -rw-r--r-- | src/lib/dispatch/lib_dispatch.dox | 14 |
1 files changed, 13 insertions, 1 deletions
diff --git a/src/lib/dispatch/lib_dispatch.dox b/src/lib/dispatch/lib_dispatch.dox index f194eff481..9f3a1fc7df 100644 --- a/src/lib/dispatch/lib_dispatch.dox +++ b/src/lib/dispatch/lib_dispatch.dox @@ -1,4 +1,16 @@ /** @dir lib/dispatch -@brief lib/dispatch +@brief lib/dispatch: In-process message delivery. + +This module provides a general in-process "message dispatch" system in which +typed messages are sent on channels. The dispatch.h header has far more +information. + +It is used by by \ref src/lib/pubsub "lib/pubsub" to implement our general +inter-module publish/subscribe system. + +This is not a fancy multi-threaded many-to-many dispatcher as you may be used +to from more sophisticated architectures: this dispatcher is intended only +for use in improving Tor's architecture. + **/ |