diff options
Diffstat (limited to 'src/lib/dispatch')
| -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. + **/ |