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.
98 lines
2.8 KiB
ReStructuredText
98 lines
2.8 KiB
ReStructuredText
|
|
.. currentmodule:: mitogen.service
|
|
|
|
.. _service:
|
|
|
|
Service Framework
|
|
=================
|
|
|
|
.. warning::
|
|
|
|
This section is incomplete.
|
|
|
|
Mitogen includes a simple framework for implementing services exposed to other
|
|
contexts, with some built-in subclasses to capture common designs. This is a
|
|
work in progress, and new functionality will be added as common usage patterns
|
|
emerge.
|
|
|
|
|
|
Overview
|
|
--------
|
|
|
|
Service
|
|
|
|
* User-supplied class with explicitly exposed methods.
|
|
* May be auto-imported/constructed in a child from a parent simply by calling it
|
|
* Identified in calls by its canonical name (e.g. mypkg.mymod.MyClass) by
|
|
default, but may use any naming scheme the configured activator understands.
|
|
* Children receive refusals if the class is not already activated by a aprent
|
|
* Has an associated Select instance which may be dynamically loaded with
|
|
receivers over time, on_message_received() invoked if any receiver becomes
|
|
ready.
|
|
|
|
Invoker
|
|
|
|
* Abstracts mechanism for calling a service method and verifying permissions.
|
|
* Built-in 'service.Invoker': concurrent execution of all methods on the thread pool.
|
|
* Built-in 'service.SerializedInvoker': serialization of all calls on a single
|
|
thread borrowed from the pool while any request is pending.
|
|
* Built-in 'service.DeduplicatingInvoker': requests are aggregated by distinct
|
|
(method, kwargs) key, only one such method ever executes, return value is
|
|
cached and broadcast to all request waiters. Waiters do not block additional
|
|
pool threads.
|
|
|
|
Activator
|
|
|
|
* Abstracts mechanism for activating a service and verifying activation
|
|
permission.
|
|
* Built-in activator looks for service by fully.qualified.ClassName using
|
|
Python import mechanism, and only permits parents to trigger activation.
|
|
|
|
Pool
|
|
|
|
* Manages a fixed-size thread pool, mapping of service name to Invoker, and an
|
|
aggregate Select over every activate service's Selects.
|
|
* Constructed automatically in children in response to the first
|
|
CALL_SERVICE message sent to them by a parent.
|
|
* Must be constructed manually in parent context.
|
|
* Has close() and add() methods.
|
|
|
|
|
|
Example
|
|
-------
|
|
|
|
.. literalinclude:: ../examples/service/self_contained.py
|
|
|
|
|
|
Reference
|
|
---------
|
|
|
|
.. autoclass:: mitogen.service.Policy
|
|
.. autoclass:: mitogen.service.AllowParents
|
|
.. autoclass:: mitogen.service.AllowAny
|
|
|
|
.. autofunction:: mitogen.service.arg_spec
|
|
.. autofunction:: mitogen.service.expose
|
|
|
|
.. autofunction:: mitogen.service.Service
|
|
|
|
.. autoclass:: mitogen.service.Invoker
|
|
.. autoclass:: mitogen.service.SerializedInvoker
|
|
.. autoclass:: mitogen.service.DeduplicatingInvoker
|
|
|
|
.. autoclass:: mitogen.service.Service
|
|
:members:
|
|
|
|
.. autoclass:: mitogen.service.Pool
|
|
:members:
|
|
|
|
|
|
Built-in Services
|
|
-----------------
|
|
|
|
.. autoclass:: mitogen.service.FileService
|
|
:members:
|
|
|
|
.. autoclass:: mitogen.service.PushFileService
|
|
:members:
|