diff options
author | Nick Mathewson <nickm@torproject.org> | 2018-11-09 10:58:20 -0500 |
---|---|---|
committer | Nick Mathewson <nickm@torproject.org> | 2018-11-09 10:58:20 -0500 |
commit | 61695e3d622dfcc196b8b829842f2b12fecebeab (patch) | |
tree | 0ef63adc6307bc19b5ec3998fcda2ea01e1bbbd6 /src | |
parent | 4fe4bcf8a10967a668895e962099f50635ba9e4b (diff) | |
download | tor-61695e3d622dfcc196b8b829842f2b12fecebeab.tar.gz tor-61695e3d622dfcc196b8b829842f2b12fecebeab.zip |
Document that subsystem callbacks are optional.
Diffstat (limited to 'src')
-rw-r--r-- | src/lib/subsys/subsys.h | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/src/lib/subsys/subsys.h b/src/lib/subsys/subsys.h index 462314567e..2452ec6e2f 100644 --- a/src/lib/subsys/subsys.h +++ b/src/lib/subsys/subsys.h @@ -14,7 +14,11 @@ struct dispatch_connector_t; * A subsystem is a part of Tor that is initialized, shut down, configured, * and connected to other parts of Tor. * - * Subsystems + * All callbacks are optional -- if a callback is set to NULL, the subsystem + * manager will treat it as a no-op. + * + * You should use c99 named-field initializers with this structure: we + * will be adding more fields, often in the middle of the structure. **/ typedef struct subsys_fns_t { /** |