205 lines
3.2 KiB
ReStructuredText
205 lines
3.2 KiB
ReStructuredText
|
|
Internal API Reference
|
|
**********************
|
|
|
|
.. toctree::
|
|
:hidden:
|
|
|
|
signals
|
|
|
|
|
|
Constants
|
|
=========
|
|
|
|
.. currentmodule:: mitogen.core
|
|
.. autodata:: CHUNK_SIZE
|
|
|
|
|
|
Poller Classes
|
|
==============
|
|
|
|
.. currentmodule:: mitogen.core
|
|
.. autoclass:: Poller
|
|
:members:
|
|
|
|
.. currentmodule:: mitogen.parent
|
|
.. autoclass:: EpollPoller
|
|
|
|
.. currentmodule:: mitogen.parent
|
|
.. autoclass:: KqueuePoller
|
|
|
|
|
|
Latch Class
|
|
===========
|
|
|
|
.. currentmodule:: mitogen.core
|
|
.. autoclass:: Latch
|
|
:members:
|
|
|
|
|
|
PidfulStreamHandler Class
|
|
=========================
|
|
|
|
.. currentmodule:: mitogen.core
|
|
.. autoclass:: PidfulStreamHandler
|
|
:members:
|
|
|
|
|
|
Side Class
|
|
==========
|
|
|
|
.. currentmodule:: mitogen.core
|
|
.. autoclass:: Side
|
|
:members:
|
|
|
|
|
|
Stream Classes
|
|
==============
|
|
|
|
.. currentmodule:: mitogen.core
|
|
.. autoclass:: BasicStream
|
|
:members:
|
|
|
|
.. autoclass:: Stream
|
|
:members:
|
|
|
|
.. currentmodule:: mitogen.fork
|
|
.. autoclass:: Stream
|
|
:members:
|
|
|
|
.. currentmodule:: mitogen.parent
|
|
.. autoclass:: Stream
|
|
:members:
|
|
|
|
.. currentmodule:: mitogen.ssh
|
|
.. autoclass:: Stream
|
|
:members:
|
|
|
|
.. currentmodule:: mitogen.sudo
|
|
.. autoclass:: Stream
|
|
:members:
|
|
|
|
|
|
Other Stream Subclasses
|
|
=======================
|
|
|
|
.. currentmodule:: mitogen.core
|
|
|
|
.. autoclass:: IoLogger
|
|
:members:
|
|
|
|
.. autoclass:: Waker
|
|
:members:
|
|
|
|
|
|
Poller Class
|
|
============
|
|
|
|
.. currentmodule:: mitogen.core
|
|
.. autoclass:: Poller
|
|
:members:
|
|
|
|
.. currentmodule:: mitogen.parent
|
|
.. autoclass:: KqueuePoller
|
|
|
|
.. currentmodule:: mitogen.parent
|
|
.. autoclass:: EpollPoller
|
|
|
|
|
|
Importer Class
|
|
==============
|
|
|
|
.. currentmodule:: mitogen.core
|
|
.. autoclass:: Importer
|
|
:members:
|
|
|
|
|
|
Responder Class
|
|
===============
|
|
|
|
.. currentmodule:: mitogen.master
|
|
.. autoclass:: ModuleResponder
|
|
:members:
|
|
|
|
|
|
RouteMonitor Class
|
|
==================
|
|
|
|
.. currentmodule:: mitogen.parent
|
|
.. autoclass:: RouteMonitor
|
|
:members:
|
|
|
|
|
|
Forwarder Class
|
|
===============
|
|
|
|
.. currentmodule:: mitogen.parent
|
|
.. autoclass:: ModuleForwarder
|
|
:members:
|
|
|
|
|
|
ExternalContext Class
|
|
=====================
|
|
|
|
.. currentmodule:: mitogen.core
|
|
.. autoclass:: ExternalContext
|
|
:members:
|
|
|
|
|
|
mitogen.master
|
|
==============
|
|
|
|
.. currentmodule:: mitogen.parent
|
|
.. autoclass:: ProcessMonitor
|
|
:members:
|
|
|
|
|
|
Blocking I/O Functions
|
|
======================
|
|
|
|
These functions exist to support the blocking phase of setting up a new
|
|
context. They will eventually be replaced with asynchronous equivalents.
|
|
|
|
|
|
.. currentmodule:: mitogen.parent
|
|
.. autofunction:: discard_until
|
|
.. autofunction:: iter_read
|
|
.. autofunction:: write_all
|
|
|
|
|
|
Subprocess Creation Functions
|
|
=============================
|
|
|
|
.. currentmodule:: mitogen.parent
|
|
.. autofunction:: create_child
|
|
.. autofunction:: hybrid_tty_create_child
|
|
.. autofunction:: tty_create_child
|
|
|
|
|
|
Helper Functions
|
|
================
|
|
|
|
.. currentmodule:: mitogen.core
|
|
.. autofunction:: to_text
|
|
.. autofunction:: has_parent_authority
|
|
.. autofunction:: set_cloexec
|
|
.. autofunction:: set_nonblock
|
|
.. autofunction:: set_block
|
|
.. autofunction:: io_op
|
|
|
|
.. currentmodule:: mitogen.parent
|
|
.. autofunction:: close_nonstandard_fds
|
|
.. autofunction:: create_socketpair
|
|
|
|
.. currentmodule:: mitogen.master
|
|
.. autofunction:: get_child_modules
|
|
|
|
.. currentmodule:: mitogen.minify
|
|
.. autofunction:: minimize_source
|
|
|
|
|
|
Signals
|
|
=======
|
|
|
|
:ref:`Please refer to Signals <signals>`.
|