issue #170: add timers to internals.rst.

pull/607/head
David Wilson 6 years ago
parent 2fbc77a155
commit 870e0b6e2d

@ -15,46 +15,49 @@ Constants
.. autodata:: CHUNK_SIZE .. autodata:: CHUNK_SIZE
Poller Classes Pollers
============== =======
.. currentmodule:: mitogen.core .. currentmodule:: mitogen.core
.. autoclass:: Poller .. autoclass:: Poller
:members: :members:
.. currentmodule:: mitogen.parent
.. autoclass:: KqueuePoller
.. currentmodule:: mitogen.parent .. currentmodule:: mitogen.parent
.. autoclass:: EpollPoller .. autoclass:: EpollPoller
.. currentmodule:: mitogen.parent .. currentmodule:: mitogen.parent
.. autoclass:: KqueuePoller .. autoclass:: PollPoller
Latch Class Latch
=========== =====
.. currentmodule:: mitogen.core .. currentmodule:: mitogen.core
.. autoclass:: Latch .. autoclass:: Latch
:members: :members:
PidfulStreamHandler Class PidfulStreamHandler
========================= ===================
.. currentmodule:: mitogen.core .. currentmodule:: mitogen.core
.. autoclass:: PidfulStreamHandler .. autoclass:: PidfulStreamHandler
:members: :members:
Side Class Side
========== ====
.. currentmodule:: mitogen.core .. currentmodule:: mitogen.core
.. autoclass:: Side .. autoclass:: Side
:members: :members:
Stream Classes Stream
============== ======
.. currentmodule:: mitogen.core .. currentmodule:: mitogen.core
.. autoclass:: BasicStream .. autoclass:: BasicStream
@ -79,42 +82,24 @@ Stream Classes
.. autoclass:: Stream .. autoclass:: Stream
:members: :members:
Other Stream Subclasses
=======================
.. currentmodule:: mitogen.core .. currentmodule:: mitogen.core
.. autoclass:: IoLogger .. autoclass:: IoLogger
:members: :members:
.. currentmodule:: mitogen.core
.. autoclass:: Waker .. autoclass:: Waker
:members: :members:
Poller Class Importer
============ ========
.. currentmodule:: mitogen.core
.. autoclass:: Poller
:members:
.. currentmodule:: mitogen.parent
.. autoclass:: KqueuePoller
.. currentmodule:: mitogen.parent
.. autoclass:: EpollPoller
Importer Class
==============
.. currentmodule:: mitogen.core .. currentmodule:: mitogen.core
.. autoclass:: Importer .. autoclass:: Importer
:members: :members:
Responder Class ModuleResponder
=============== ===============
.. currentmodule:: mitogen.master .. currentmodule:: mitogen.master
@ -122,40 +107,59 @@ Responder Class
:members: :members:
RouteMonitor Class RouteMonitor
================== ============
.. currentmodule:: mitogen.parent .. currentmodule:: mitogen.parent
.. autoclass:: RouteMonitor .. autoclass:: RouteMonitor
:members: :members:
Forwarder Class TimerList
=============== =========
.. currentmodule:: mitogen.parent
.. autoclass:: TimerList
:members:
Timer
=====
.. currentmodule:: mitogen.parent
.. autoclass:: Timer
:members:
Forwarder
=========
.. currentmodule:: mitogen.parent .. currentmodule:: mitogen.parent
.. autoclass:: ModuleForwarder .. autoclass:: ModuleForwarder
:members: :members:
ExternalContext Class ExternalContext
===================== ===============
.. currentmodule:: mitogen.core .. currentmodule:: mitogen.core
.. autoclass:: ExternalContext .. autoclass:: ExternalContext
:members: :members:
mitogen.master Process
============== =======
.. currentmodule:: mitogen.parent .. currentmodule:: mitogen.parent
.. autoclass:: ProcessMonitor .. autoclass:: Process
:members: :members:
Blocking I/O Functions Helpers
====================== =======
Blocking I/O
------------
These functions exist to support the blocking phase of setting up a new These functions exist to support the blocking phase of setting up a new
context. They will eventually be replaced with asynchronous equivalents. context. They will eventually be replaced with asynchronous equivalents.
@ -167,8 +171,8 @@ context. They will eventually be replaced with asynchronous equivalents.
.. autofunction:: write_all .. autofunction:: write_all
Subprocess Creation Functions Subprocess Functions
============================= ------------
.. currentmodule:: mitogen.parent .. currentmodule:: mitogen.parent
.. autofunction:: create_child .. autofunction:: create_child
@ -176,8 +180,8 @@ Subprocess Creation Functions
.. autofunction:: tty_create_child .. autofunction:: tty_create_child
Helper Functions Helpers
================ -------
.. currentmodule:: mitogen.core .. currentmodule:: mitogen.core
.. autofunction:: to_text .. autofunction:: to_text

Loading…
Cancel
Save