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
==============
econtext Package
----------------
.. automodule:: econtext
.. autodata:: econtext.slave
.. autodata:: econtext.context_id
.. autodata:: econtext.parent_id
econtext.core
-------------
.. automodule:: econtext.core
econtext.master
---------------
.. automodule:: econtext.master
econtext.fakessh
---------------
.. automodule:: econtext.fakessh
.. autofunction:: econtext.fakessh.run
Router Class
============
.. autoclass:: econtext.master.Router
:members:
:inherited-members:
Broker Class
============
.. autoclass:: econtext.master.Broker
:members:
:inherited-members:
Context Class
=============
.. autoclass:: econtext.master.Context
:members:
:inherited-members:
Channel Class
-------------
.. autoclass:: econtext.core.Channel
:members:
Context Class
-------------
.. autoclass:: econtext.master.Context
:members:
Utility Functions
=================
.. automodule:: econtext.utils
:members:
Exceptions
==========
.. autoclass:: econtext.core.Error
.. autoclass:: econtext.core.CallError
.. autoclass:: econtext.core.ChannelError
.. autoclass:: econtext.core.StreamError
.. autoclass:: econtext.core.TimeoutError