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

140 lines
3.0 KiB
ReStructuredText
Raw Normal View History

Initial intro doc.
2016-08-12 17:45:26 +00:00
API Reference
Many docs updates.
2016-08-13 23:16:17 +00:00
*************
Rearrange docs, split connection methods into submodules.
2016-08-19 14:16:31 +00:00
Package Layout
==============
Rename package.
2017-09-11 04:08:28 +00:00
mitogen Package
---------------
Many docs updates.
2016-08-13 23:16:17 +00:00
Rename package.
2017-09-11 04:08:28 +00:00
.. automodule:: mitogen
Many docs updates.
2016-08-13 23:16:17 +00:00
fix unbelievably dumb variable shadowing
2017-09-16 23:53:44 +00:00
.. autodata:: mitogen.is_master
Rename package.
2017-09-11 04:08:28 +00:00
.. autodata:: mitogen.context_id
.. autodata:: mitogen.parent_id
Tidy up docs.
2017-09-07 11:08:05 +00:00
Initial intro doc.
2016-08-12 17:45:26 +00:00
Rename package.
2017-09-11 04:08:28 +00:00
mitogen.core
------------
Initial intro doc.
2016-08-12 17:45:26 +00:00
Move more docstrings out of core.py.
2017-09-18 09:20:41 +00:00
.. module:: mitogen.core
This module implements most package functionality, but remains separate from
non-essential code in order to reduce its size, since it is also serves as the
bootstrap implementation sent to every new slave context.
Many docs updates.
2016-08-13 23:16:17 +00:00
core: support takes_econtext and takes_router decorators.
2017-09-17 17:22:11 +00:00
.. function:: mitogen.core.takes_econtext
Decorator that marks a function or class method to automatically receive a
kwarg named `econtext`, referencing the
:py:class:`econtext.core.ExternalContext` active in the context in which
the function is being invoked in. The decorator is only meaningful when the
function is invoked via :py:data:`econtext.core.CALL_FUNCTION`.
When the function is invoked directly, `econtext` must still be passed to it
explicitly.
.. function:: mitogen.core.takes_router
Decorator that marks a function or class method to automatically receive a
kwarg named `router`, referencing the :py:class:`econtext.core.Router`
active in the context in which the function is being invoked in. The
decorator is only meaningful when the function is invoked via
:py:data:`econtext.core.CALL_FUNCTION`.
When the function is invoked directly, `router` must still be passed to it
explicitly.
Many docs updates.
2016-08-13 23:16:17 +00:00
Rename package.
2017-09-11 04:08:28 +00:00
mitogen.master
--------------
Many docs updates.
2016-08-13 23:16:17 +00:00
Document a bunch of mitogen.master and move more docstrings into Sphinx.
2017-09-21 11:34:03 +00:00
.. module:: mitogen.master
This module implements functionality required by master processes, such as
starting new contexts via SSH. Its size is also restricted, since it must
be sent to any context that will be used to establish additional child
contexts.
Many docs updates.
2016-08-13 23:16:17 +00:00
Rename package.
2017-09-11 04:08:28 +00:00
mitogen.fakessh
Tidy up docs.
2017-09-07 11:08:05 +00:00
---------------
Many updates: graceful shutdown, docs, threading * Start splitting docs up into internals.rst / api.rst * Docs for lots more of econtext.core. * Get rid of _update_stream() and has_output(), replace with individual functions called as state changes. * Add Broker.on_thread() and remove Stream._lock: simply call on_thread() to ensure buffer management is linearized. * Rename read_side/write_side to receive_side/transmit_side like event handler names. * Clean up some more repr / debug logs. * Move handle cleanup to Context.on_shutdown where it belongs. * Make wake() a noop when called from broker thread. * Replace graceful_count crap with Side.graceful attribute, add Broker.keep_alive() to check whether any registered readers want to be kept alive for graceful shutdown() or any child contexts with a connected stream exist. * Make master.Broker timeout slightly longer than slave broker. * Add generic on_thread() to allow running code on the IO thread.
2016-08-16 00:57:08 +00:00
Rename package.
2017-09-11 04:08:28 +00:00
.. automodule:: mitogen.fakessh
Rearrange docs, split connection methods into submodules.
2016-08-19 14:16:31 +00:00
Rename package.
2017-09-11 04:08:28 +00:00
.. autofunction:: mitogen.fakessh.run
Tidy up docs.
2017-09-07 11:08:05 +00:00
Router Class
============
Rename package.
2017-09-11 04:08:28 +00:00
.. autoclass:: mitogen.master.Router
Tidy up docs.
2017-09-07 11:08:05 +00:00
:members:
:inherited-members:
Many updates: graceful shutdown, docs, threading * Start splitting docs up into internals.rst / api.rst * Docs for lots more of econtext.core. * Get rid of _update_stream() and has_output(), replace with individual functions called as state changes. * Add Broker.on_thread() and remove Stream._lock: simply call on_thread() to ensure buffer management is linearized. * Rename read_side/write_side to receive_side/transmit_side like event handler names. * Clean up some more repr / debug logs. * Move handle cleanup to Context.on_shutdown where it belongs. * Make wake() a noop when called from broker thread. * Replace graceful_count crap with Side.graceful attribute, add Broker.keep_alive() to check whether any registered readers want to be kept alive for graceful shutdown() or any child contexts with a connected stream exist. * Make master.Broker timeout slightly longer than slave broker. * Add generic on_thread() to allow running code on the IO thread.
2016-08-16 00:57:08 +00:00
Broker Class
Rearrange docs, split connection methods into submodules.
2016-08-19 14:16:31 +00:00
============
Many updates: graceful shutdown, docs, threading * Start splitting docs up into internals.rst / api.rst * Docs for lots more of econtext.core. * Get rid of _update_stream() and has_output(), replace with individual functions called as state changes. * Add Broker.on_thread() and remove Stream._lock: simply call on_thread() to ensure buffer management is linearized. * Rename read_side/write_side to receive_side/transmit_side like event handler names. * Clean up some more repr / debug logs. * Move handle cleanup to Context.on_shutdown where it belongs. * Make wake() a noop when called from broker thread. * Replace graceful_count crap with Side.graceful attribute, add Broker.keep_alive() to check whether any registered readers want to be kept alive for graceful shutdown() or any child contexts with a connected stream exist. * Make master.Broker timeout slightly longer than slave broker. * Add generic on_thread() to allow running code on the IO thread.
2016-08-16 00:57:08 +00:00
Rename package.
2017-09-11 04:08:28 +00:00
.. autoclass:: mitogen.master.Broker
Many updates: graceful shutdown, docs, threading * Start splitting docs up into internals.rst / api.rst * Docs for lots more of econtext.core. * Get rid of _update_stream() and has_output(), replace with individual functions called as state changes. * Add Broker.on_thread() and remove Stream._lock: simply call on_thread() to ensure buffer management is linearized. * Rename read_side/write_side to receive_side/transmit_side like event handler names. * Clean up some more repr / debug logs. * Move handle cleanup to Context.on_shutdown where it belongs. * Make wake() a noop when called from broker thread. * Replace graceful_count crap with Side.graceful attribute, add Broker.keep_alive() to check whether any registered readers want to be kept alive for graceful shutdown() or any child contexts with a connected stream exist. * Make master.Broker timeout slightly longer than slave broker. * Add generic on_thread() to allow running code on the IO thread.
2016-08-16 00:57:08 +00:00
:members:
Rearrange docs, split connection methods into submodules.
2016-08-19 14:16:31 +00:00
:inherited-members:
Many updates: graceful shutdown, docs, threading * Start splitting docs up into internals.rst / api.rst * Docs for lots more of econtext.core. * Get rid of _update_stream() and has_output(), replace with individual functions called as state changes. * Add Broker.on_thread() and remove Stream._lock: simply call on_thread() to ensure buffer management is linearized. * Rename read_side/write_side to receive_side/transmit_side like event handler names. * Clean up some more repr / debug logs. * Move handle cleanup to Context.on_shutdown where it belongs. * Make wake() a noop when called from broker thread. * Replace graceful_count crap with Side.graceful attribute, add Broker.keep_alive() to check whether any registered readers want to be kept alive for graceful shutdown() or any child contexts with a connected stream exist. * Make master.Broker timeout slightly longer than slave broker. * Add generic on_thread() to allow running code on the IO thread.
2016-08-16 00:57:08 +00:00
Many docs updates.
2016-08-13 23:16:17 +00:00
Context Class
Rearrange docs, split connection methods into submodules.
2016-08-19 14:16:31 +00:00
=============
Many docs updates.
2016-08-13 23:16:17 +00:00
Rename package.
2017-09-11 04:08:28 +00:00
.. autoclass:: mitogen.master.Context
Many docs updates.
2016-08-13 23:16:17 +00:00
:members:
Rearrange docs, split connection methods into submodules.
2016-08-19 14:16:31 +00:00
:inherited-members:
Many docs updates.
2016-08-13 23:16:17 +00:00
Channel Class
-------------
Rename package.
2017-09-11 04:08:28 +00:00
.. autoclass:: mitogen.core.Channel
Initial intro doc.
2016-08-12 17:45:26 +00:00
:members:
Many updates: graceful shutdown, docs, threading * Start splitting docs up into internals.rst / api.rst * Docs for lots more of econtext.core. * Get rid of _update_stream() and has_output(), replace with individual functions called as state changes. * Add Broker.on_thread() and remove Stream._lock: simply call on_thread() to ensure buffer management is linearized. * Rename read_side/write_side to receive_side/transmit_side like event handler names. * Clean up some more repr / debug logs. * Move handle cleanup to Context.on_shutdown where it belongs. * Make wake() a noop when called from broker thread. * Replace graceful_count crap with Side.graceful attribute, add Broker.keep_alive() to check whether any registered readers want to be kept alive for graceful shutdown() or any child contexts with a connected stream exist. * Make master.Broker timeout slightly longer than slave broker. * Add generic on_thread() to allow running code on the IO thread.
2016-08-16 00:57:08 +00:00
Context Class
-------------
Many docs updates.
2016-08-13 23:16:17 +00:00
Rename package.
2017-09-11 04:08:28 +00:00
.. autoclass:: mitogen.master.Context
Many docs updates.
2016-08-13 23:16:17 +00:00
:members:
Rearrange docs, split connection methods into submodules.
2016-08-19 14:16:31 +00:00
Utility Functions
=================
Many docs updates.
2016-08-13 23:16:17 +00:00
Rename package.
2017-09-11 04:08:28 +00:00
.. automodule:: mitogen.utils
Many docs updates.
2016-08-13 23:16:17 +00:00
:members:
Rearrange docs, split connection methods into submodules.
2016-08-19 14:16:31 +00:00
Exceptions
==========
Move more docstrings out of core.py.
2017-09-18 09:20:41 +00:00
.. class:: mitogen.core.Error (fmt, \*args)
Base for all exceptions raised by Mitogen.
.. class:: mitogen.core.CallError (e)
Raised when :py:meth:`Context.call() <mitogen.master.Context.call>` fails.
A copy of the traceback from the external context is appended to the
exception message.
.. class:: mitogen.core.ChannelError (fmt, \*args)
Raised when a channel dies or has been closed.
.. class:: mitogen.core.StreamError (fmt, \*args)
Raised when a stream cannot be established.
.. autoclass:: mitogen.core.TimeoutError (fmt, \*args)
Raised when a timeout occurs on a stream.