Rooba
/
mitogen
mirror of https://github.com/mitogen-hq/mitogen.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity
mitogen/docs/internals.rst

191 lines
3.0 KiB
ReStructuredText
Raw Normal View History

Initial commit.
2017-09-15 06:24:41 +00:00
Internal API Reference
**********************
docs: link signals into internals.rst.
2018-05-04 02:47:29 +00:00
.. toctree::
:hidden:
signals
Initial commit.
2017-09-15 06:24:41 +00:00
docs: document mitogen.core.CHUNK_SIZE.
2018-08-18 15:11:18 +00:00
Constants
=========
.. currentmodule:: mitogen.core
.. autodata:: CHUNK_SIZE
docs: mitogen.core.Latch docs
2018-02-28 16:15:35 +00:00
Latch Class
docs: merge more docs back into mitogen/core.py.
2018-08-18 13:15:37 +00:00
===========
docs: mitogen.core.Latch docs
2018-02-28 16:15:35 +00:00
.. currentmodule:: mitogen.core
docs: merge more docs back into mitogen/core.py.
2018-08-18 13:15:37 +00:00
.. autoclass:: Latch
:members:
docs: mitogen.core.Latch docs
2018-02-28 16:15:35 +00:00
docs: merge more docs back into mitogen/core.py.
2018-08-18 13:15:37 +00:00
PidfulStreamHandler Class
=========================
.. currentmodule:: mitogen.core
.. autoclass:: PidfulStreamHandler
:members:
core: support throwing LatchError in every sleeping thread This is to allow Select() to be used as a generic queueing primitive that supports graceful shutdown.
2018-03-18 12:31:24 +00:00
docs: mitogen.core.Latch docs
2018-02-28 16:15:35 +00:00
Initial commit.
2017-09-15 06:24:41 +00:00
Side Class
docs: fix internals.rst headings.
2018-10-31 15:08:27 +00:00
==========
Initial commit.
2017-09-15 06:24:41 +00:00
docs: Fix index generation everywhere.
2017-09-29 14:52:43 +00:00
.. currentmodule:: mitogen.core
docs: move most remaining docstrings back into *.py; closes #388 The remaining ones are decorators which don't seem to have an autodoc equivlent.
2018-11-02 12:56:13 +00:00
.. autoclass:: Side
:members:
Initial commit.
2017-09-15 06:24:41 +00:00
Stream Classes
docs: fix internals.rst headings.
2018-10-31 15:08:27 +00:00
==============
Initial commit.
2017-09-15 06:24:41 +00:00
docs: Fix index generation everywhere.
2017-09-29 14:52:43 +00:00
.. currentmodule:: mitogen.core
docs: move most remaining docstrings back into *.py; closes #388 The remaining ones are decorators which don't seem to have an autodoc equivlent.
2018-11-02 12:56:13 +00:00
.. autoclass:: BasicStream
:members:
Initial commit.
2017-09-15 06:24:41 +00:00
docs: add mitogen.fork.Stream to internals.rst
2018-03-24 10:08:06 +00:00
.. autoclass:: Stream
:members:
.. currentmodule:: mitogen.fork
docs: Fix index generation everywhere.
2017-09-29 14:52:43 +00:00
.. autoclass:: Stream
Initial commit.
2017-09-15 06:24:41 +00:00
:members:
Add mitogen.main() decorator mainly for docs and demo use.
2018-02-13 14:14:26 +00:00
.. currentmodule:: mitogen.parent
docs: Fix index generation everywhere.
2017-09-29 14:52:43 +00:00
.. autoclass:: Stream
Initial commit.
2017-09-15 06:24:41 +00:00
:members:
docs: Fix index generation everywhere.
2017-09-29 14:52:43 +00:00
.. currentmodule:: mitogen.ssh
.. autoclass:: Stream
:members:
.. currentmodule:: mitogen.sudo
.. autoclass:: Stream
Initial commit.
2017-09-15 06:24:41 +00:00
:members:
Other Stream Subclasses
docs: fix internals.rst headings.
2018-10-31 15:08:27 +00:00
=======================
Initial commit.
2017-09-15 06:24:41 +00:00
docs: Fix index generation everywhere.
2017-09-29 14:52:43 +00:00
.. currentmodule:: mitogen.core
.. autoclass:: IoLogger
Initial commit.
2017-09-15 06:24:41 +00:00
:members:
docs: Fix index generation everywhere.
2017-09-29 14:52:43 +00:00
.. autoclass:: Waker
Initial commit.
2017-09-15 06:24:41 +00:00
:members:
issue #249: initial poller implementation (BSD only)
2018-05-14 17:28:05 +00:00
Poller Class
docs: fix internals.rst headings.
2018-10-31 15:08:27 +00:00
============
issue #249: initial poller implementation (BSD only)
2018-05-14 17:28:05 +00:00
.. currentmodule:: mitogen.core
.. autoclass:: Poller
docs: move most remaining docstrings back into *.py; closes #388 The remaining ones are decorators which don't seem to have an autodoc equivlent.
2018-11-02 12:56:13 +00:00
:members:
issue #249: initial poller implementation (BSD only)
2018-05-14 17:28:05 +00:00
.. currentmodule:: mitogen.parent
.. autoclass:: KqueuePoller
.. currentmodule:: mitogen.parent
.. autoclass:: EpollPoller
docs: Fix up tons of references, document trust chain
2017-10-03 13:48:43 +00:00
Importer Class
docs: fix internals.rst headings.
2018-10-31 15:08:27 +00:00
==============
docs: Fix up tons of references, document trust chain
2017-10-03 13:48:43 +00:00
.. currentmodule:: mitogen.core
.. autoclass:: Importer
:members:
Initial commit.
2017-09-15 06:24:41 +00:00
importer: Beginnings of howitworks section.
2018-02-11 18:00:38 +00:00
Responder Class
docs: fix internals.rst headings.
2018-10-31 15:08:27 +00:00
===============
importer: Beginnings of howitworks section.
2018-02-11 18:00:38 +00:00
.. currentmodule:: mitogen.master
.. autoclass:: ModuleResponder
:members:
docs: document RouteMonitor class.
2018-10-31 15:06:28 +00:00
RouteMonitor Class
docs: fix internals.rst headings.
2018-10-31 15:08:27 +00:00
==================
docs: document RouteMonitor class.
2018-10-31 15:06:28 +00:00
.. currentmodule:: mitogen.parent
.. autoclass:: RouteMonitor
:members:
importer: Beginnings of howitworks section.
2018-02-11 18:00:38 +00:00
Forwarder Class
docs: fix internals.rst headings.
2018-10-31 15:08:27 +00:00
===============
importer: Beginnings of howitworks section.
2018-02-11 18:00:38 +00:00
Add mitogen.main() decorator mainly for docs and demo use.
2018-02-13 14:14:26 +00:00
.. currentmodule:: mitogen.parent
importer: Beginnings of howitworks section.
2018-02-11 18:00:38 +00:00
.. autoclass:: ModuleForwarder
:members:
Initial commit.
2017-09-15 06:24:41 +00:00
ExternalContext Class
docs: fix internals.rst headings.
2018-10-31 15:08:27 +00:00
=====================
Initial commit.
2017-09-15 06:24:41 +00:00
docs: Fix index generation everywhere.
2017-09-29 14:52:43 +00:00
.. currentmodule:: mitogen.core
docs: move most remaining docstrings back into *.py; closes #388 The remaining ones are decorators which don't seem to have an autodoc equivlent.
2018-11-02 12:56:13 +00:00
.. autoclass:: ExternalContext
:members:
docs: Fix index generation everywhere.
2017-09-29 14:52:43 +00:00
Initial commit.
2017-09-15 06:24:41 +00:00
mitogen.master
Document a bunch of mitogen.master and move more docstrings into Sphinx.
2017-09-21 11:34:03 +00:00
==============
Initial commit.
2017-09-15 06:24:41 +00:00
docs: move most remaining docstrings back into *.py; closes #388 The remaining ones are decorators which don't seem to have an autodoc equivlent.
2018-11-02 12:56:13 +00:00
.. currentmodule:: mitogen.parent
.. autoclass:: ProcessMonitor
:members:
Document a bunch of mitogen.master and move more docstrings into Sphinx.
2017-09-21 11:34:03 +00:00
Blocking I/O Functions
docs: many more fixes/merges.
2018-08-18 13:33:55 +00:00
======================
Document a bunch of mitogen.master and move more docstrings into Sphinx.
2017-09-21 11:34:03 +00:00
These functions exist to support the blocking phase of setting up a new
context. They will eventually be replaced with asynchronous equivalents.
docs: many more fixes/merges.
2018-08-18 13:33:55 +00:00
.. currentmodule:: mitogen.parent
.. autofunction:: discard_until
.. autofunction:: iter_read
.. autofunction:: write_all
Document a bunch of mitogen.master and move more docstrings into Sphinx.
2017-09-21 11:34:03 +00:00
docs: many more fixes/merges.
2018-08-18 13:33:55 +00:00
Subprocess Creation Functions
=============================
Document a bunch of mitogen.master and move more docstrings into Sphinx.
2017-09-21 11:34:03 +00:00
docs: many more fixes/merges.
2018-08-18 13:33:55 +00:00
.. currentmodule:: mitogen.parent
.. autofunction:: create_child
.. autofunction:: hybrid_tty_create_child
.. autofunction:: tty_create_child
Initial commit.
2017-09-15 06:24:41 +00:00
Helper Functions
docs: merge more docs back into mitogen/core.py.
2018-08-18 13:15:37 +00:00
================
Initial commit.
2017-09-15 06:24:41 +00:00
docs: Fix index generation everywhere.
2017-09-29 14:52:43 +00:00
.. currentmodule:: mitogen.core
docs: merge more docs back into mitogen/core.py.
2018-08-18 13:15:37 +00:00
.. autofunction:: to_text
.. autofunction:: has_parent_authority
.. autofunction:: set_cloexec
.. autofunction:: set_nonblock
.. autofunction:: set_block
.. autofunction:: io_op
docs: Fix index generation everywhere.
2017-09-29 14:52:43 +00:00
docs: document one more.
2018-08-18 14:16:12 +00:00
.. currentmodule:: mitogen.parent
.. autofunction:: close_nonstandard_fds
.. autofunction:: create_socketpair
Move more docstrings out of core.py.
2017-09-18 09:20:41 +00:00
docs: Fix index generation everywhere.
2017-09-29 14:52:43 +00:00
.. currentmodule:: mitogen.master
docs: many more fixes/merges.
2018-08-18 13:33:55 +00:00
.. autofunction:: get_child_modules
Document a bunch of mitogen.master and move more docstrings into Sphinx.
2017-09-21 11:34:03 +00:00
docs: small reference fixes.
2018-07-08 21:00:00 +00:00
.. currentmodule:: mitogen.minify
docs: many more fixes/merges.
2018-08-18 13:33:55 +00:00
.. autofunction:: minimize_source
docs: link signals into internals.rst.
2018-05-04 02:47:29 +00:00
Signals
=======
:ref:`Please refer to Signals <signals>`.