mitogen/docs/api.rst


API Reference
*************


Package Layout
==============


mitogen Package
---------------

.. automodule:: mitogen

.. autodata:: mitogen.is_master
.. autodata:: mitogen.context_id
.. autodata:: mitogen.parent_id


mitogen.core
------------

.. automodule:: mitogen.core


mitogen.master
--------------

.. automodule:: mitogen.master


mitogen.fakessh
---------------

.. automodule:: mitogen.fakessh

.. autofunction:: mitogen.fakessh.run


Router Class
============

.. autoclass:: mitogen.master.Router
   :members:
   :inherited-members:


Broker Class
============

.. autoclass:: mitogen.master.Broker
   :members:
   :inherited-members:


Context Class
=============

.. autoclass:: mitogen.master.Context
   :members:
   :inherited-members:


Channel Class
-------------

.. autoclass:: mitogen.core.Channel
   :members:


Context Class
-------------

.. autoclass:: mitogen.master.Context
   :members:


Utility Functions
=================

.. automodule:: mitogen.utils
  :members:


Exceptions
==========

.. autoclass:: mitogen.core.Error
.. autoclass:: mitogen.core.CallError
.. autoclass:: mitogen.core.ChannelError
.. autoclass:: mitogen.core.StreamError
.. autoclass:: mitogen.core.TimeoutError
Initial intro doc. 8 years ago
			`API Reference`
Many docs updates. 8 years ago			`*************`


Rearrange docs, split connection methods into submodules. 8 years ago			`Package Layout`
			`==============`


Rename package. 7 years ago			`mitogen Package`
			`---------------`
Many docs updates. 8 years ago
Rename package. 7 years ago			`.. automodule:: mitogen`
Many docs updates. 8 years ago
fix unbelievably dumb variable shadowing 7 years ago			`.. autodata:: mitogen.is_master`
Rename package. 7 years ago			`.. autodata:: mitogen.context_id`
			`.. autodata:: mitogen.parent_id`
Tidy up docs. 7 years ago
Initial intro doc. 8 years ago
Rename package. 7 years ago			`mitogen.core`
			`------------`
Initial intro doc. 8 years ago
Rename package. 7 years ago			`.. automodule:: mitogen.core`
Many docs updates. 8 years ago

Rename package. 7 years ago			`mitogen.master`
			`--------------`
Many docs updates. 8 years ago
Rename package. 7 years ago			`.. automodule:: mitogen.master`
Many docs updates. 8 years ago

Rename package. 7 years ago			`mitogen.fakessh`
Tidy up docs. 7 years ago			`---------------`
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. 8 years ago
Rename package. 7 years ago			`.. automodule:: mitogen.fakessh`
Rearrange docs, split connection methods into submodules. 8 years ago
Rename package. 7 years ago			`.. autofunction:: mitogen.fakessh.run`
Tidy up docs. 7 years ago

			`Router Class`
			`============`

Rename package. 7 years ago			`.. autoclass:: mitogen.master.Router`
Tidy up docs. 7 years ago			`: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. 8 years ago

			`Broker Class`
Rearrange docs, split connection methods into submodules. 8 years ago			`============`
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. 8 years ago
Rename package. 7 years ago			`.. 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. 8 years ago			`:members:`
Rearrange docs, split connection methods into submodules. 8 years ago			`: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. 8 years ago

Many docs updates. 8 years ago			`Context Class`
Rearrange docs, split connection methods into submodules. 8 years ago			`=============`
Many docs updates. 8 years ago
Rename package. 7 years ago			`.. autoclass:: mitogen.master.Context`
Many docs updates. 8 years ago			`:members:`
Rearrange docs, split connection methods into submodules. 8 years ago			`:inherited-members:`
Many docs updates. 8 years ago

			`Channel Class`
			`-------------`

Rename package. 7 years ago			`.. autoclass:: mitogen.core.Channel`
Initial intro doc. 8 years ago			`: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. 8 years ago			`Context Class`
			`-------------`
Many docs updates. 8 years ago
Rename package. 7 years ago			`.. autoclass:: mitogen.master.Context`
Many docs updates. 8 years ago			`:members:`


Rearrange docs, split connection methods into submodules. 8 years ago			`Utility Functions`
			`=================`
Many docs updates. 8 years ago
Rename package. 7 years ago			`.. automodule:: mitogen.utils`
Many docs updates. 8 years ago			`:members:`
Rearrange docs, split connection methods into submodules. 8 years ago

			`Exceptions`
			`==========`

Rename package. 7 years ago			`.. autoclass:: mitogen.core.Error`
			`.. autoclass:: mitogen.core.CallError`
			`.. autoclass:: mitogen.core.ChannelError`
			`.. autoclass:: mitogen.core.StreamError`
			`.. autoclass:: mitogen.core.TimeoutError`