You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
mitogen/docs/api.rst

93 lines
1.2 KiB
ReStructuredText

API Reference
*************
Package Layout
==============
7 years ago
mitogen Package
---------------
7 years ago
.. automodule:: mitogen
.. autodata:: mitogen.is_master
7 years ago
.. autodata:: mitogen.context_id
.. autodata:: mitogen.parent_id
7 years ago
7 years ago
mitogen.core
------------
7 years ago
.. automodule:: mitogen.core
7 years ago
mitogen.master
--------------
7 years ago
.. automodule:: mitogen.master
7 years ago
mitogen.fakessh
7 years ago
---------------
7 years ago
.. automodule:: mitogen.fakessh
7 years ago
.. autofunction:: mitogen.fakessh.run
7 years ago
Router Class
============
7 years ago
.. autoclass:: mitogen.master.Router
7 years ago
:members:
:inherited-members:
Broker Class
============
7 years ago
.. autoclass:: mitogen.master.Broker
:members:
:inherited-members:
Context Class
=============
7 years ago
.. autoclass:: mitogen.master.Context
:members:
:inherited-members:
Channel Class
-------------
7 years ago
.. autoclass:: mitogen.core.Channel
:members:
Context Class
-------------
7 years ago
.. autoclass:: mitogen.master.Context
:members:
Utility Functions
=================
7 years ago
.. automodule:: mitogen.utils
:members:
Exceptions
==========
7 years ago
.. autoclass:: mitogen.core.Error
.. autoclass:: mitogen.core.CallError
.. autoclass:: mitogen.core.ChannelError
.. autoclass:: mitogen.core.StreamError
.. autoclass:: mitogen.core.TimeoutError