DORMANT and ACTIVE signals

Stem support for a couple new signals. Sounds like a neat capability!

  https://gitweb.torproject.org/torspec.git/commit/?id=4421149
This commit is contained in:
Damian Johnson 2018-11-28 17:08:07 -08:00
parent 8d43e5810c
commit afbfb424c1
3 changed files with 9 additions and 0 deletions

View File

@ -48,6 +48,7 @@ The following are only available within Stem's `git repository
* **Controller**
* Controller events could fail to be delivered in a timely fashion (:trac:`27173`)
* **DORMANT** and **ACTIVE** :data:`~stem.Signal` (:spec:`4421149`)
* **Descriptors**

View File

@ -49,6 +49,10 @@ Library for working with the tor process.
.. versionchanged:: 1.3.0
Added the HEARTBEAT signal.
.. versionchanged:: 1.8.0
Added the ACTIVE and DORMANT signals. You can check for Tor support for
these signals with the **DORMANT_MODE** :data:`~stem.version.Requirement`
========================= ===========
Signal Description
========================= ===========
@ -60,6 +64,8 @@ Library for working with the tor process.
**NEWNYM** switch to new circuits, so new application requests don't share any circuits with old ones (this also clears our DNS cache)
**CLEARDNSCACHE** clears cached DNS results
**HEARTBEAT** trigger a heartbeat log message
**DORMANT** enables *dormant mode*, during which tor will avoid cpu and network usage
**ACTIVE** disables *dormant mode*
========================= ===========
.. data:: Flag (enum)

View File

@ -36,6 +36,7 @@ easily parsed and compared, for instance...
===================================== ===========
**AUTH_SAFECOOKIE** SAFECOOKIE authentication method
**DESCRIPTOR_COMPRESSION** `Expanded compression support for ZSTD and LZMA <https://gitweb.torproject.org/torspec.git/commit/?id=1cb56afdc1e55e303e3e6b69e90d983ee217d93f>`_
**DORMANT_MODE** **DORMANT** and **ACTIVE** :data:`~stem.Signal`
**DROPGUARDS** DROPGUARDS requests
**EVENT_AUTHDIR_NEWDESCS** AUTHDIR_NEWDESC events
**EVENT_BUILDTIMEOUT_SET** BUILDTIMEOUT_SET events
@ -351,6 +352,7 @@ safecookie_req.greater_than(Version('0.2.3.13'))
Requirement = stem.util.enum.Enum(
('AUTH_SAFECOOKIE', safecookie_req),
('DESCRIPTOR_COMPRESSION', Version('0.3.1.1-alpha')),
('DORMANT_MODE', Version('0.4.0.1-alpha')),
('DROPGUARDS', Version('0.2.5.1-alpha')),
('EVENT_AUTHDIR_NEWDESCS', Version('0.1.1.10-alpha')),
('EVENT_BUILDTIMEOUT_SET', Version('0.2.2.7-alpha')),