mitogen/docs/api.rst

120 lines
1.8 KiB
ReStructuredText
Raw Normal View History

2016-08-12 17:45:26 +00:00
API Reference
2016-08-13 23:16:17 +00:00
*************
econtext Package
================
.. automodule:: econtext
.. autodata:: econtext.slave
2016-08-12 17:45:26 +00:00
econtext.core
2016-08-13 23:16:17 +00:00
=============
2016-08-12 17:45:26 +00:00
.. automodule:: econtext.core
2016-08-13 23:16:17 +00:00
Exceptions
----------
.. autoclass:: econtext.core.Error
.. autoclass:: econtext.core.CallError
.. autoclass:: econtext.core.ChannelError
.. autoclass:: econtext.core.StreamError
.. autoclass:: econtext.core.TimeoutError
Stream Classes
--------------
.. autoclass:: econtext.core.Stream
:members:
Broker Class
------------
.. autoclass:: econtext.core.Broker
:members:
2016-08-13 23:16:17 +00:00
Context Class
-------------
.. autoclass:: econtext.core.Context
:members:
Channel Class
-------------
.. autoclass:: econtext.core.Channel
2016-08-12 17:45:26 +00:00
:members:
ExternalContext Class
---------------------
.. class:: econtext.core.ExternalContext
External context implementation.
.. attribute:: broker
The :py:class:`econtext.core.Broker` instance.
.. attribute:: context
The :py:class:`econtext.core.Context` instance.
.. attribute:: channel
The :py:class:`econtext.core.Channel` over which
:py:data:`CALL_FUNCTION` requests are received.
.. attribute:: stdout_log
The :py:class:`econtext.core.IoLogger` connected to ``stdout``.
.. attribute:: importer
The :py:class:`econtext.core.Importer` instance.
.. attribute:: stdout_log
The :py:class:`IoLogger` connected to ``stdout``.
.. attribute:: stderr_log
The :py:class:`IoLogger` connected to ``stderr``.
2016-08-12 17:45:26 +00:00
econtext.master
2016-08-13 23:16:17 +00:00
===============
2016-08-12 17:45:26 +00:00
.. automodule:: econtext.master
2016-08-13 23:16:17 +00:00
2016-08-14 00:17:03 +00:00
Broker Class
------------
2016-08-13 23:16:17 +00:00
2016-08-14 00:17:03 +00:00
.. autoclass:: econtext.master.Broker
2016-08-12 17:45:26 +00:00
:members:
2016-08-13 23:16:17 +00:00
Context Class
-------------
2016-08-13 23:16:17 +00:00
.. autoclass:: econtext.master.Context
2016-08-13 23:16:17 +00:00
:members:
econtext.utils
==============
.. automodule:: econtext.utils
:members: