openstack/oslo.messaging
Code Issues Proposed changes

add plugin documentation for executors and notifiers

Browse Source 
Document the plugins available for executors and notifiers.

Fix the formatting in the aioeventlet executor so the docstring renders
properly.

Change-Id: I7709b65f5aa68fab3822b4de11640309aa07b1d7
This commit is contained in:
Doug Hellmann 2015-07-20 18:30:00 +00:00
parent d94d6d6892
commit 1b390c34b0
3 changed files with 19 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
doc/source/executors.rst
View File

@ -1,15 +1,13 @@
--------- =========
Executors Executors
--------- =========
.. automodule:: oslo_messaging._executors
.. currentmodule:: oslo_messaging
==============
Executor types
==============
Executors are providing the way an incoming message will be dispatched so that Executors are providing the way an incoming message will be dispatched so that
the message can be used for meaningful work. Different types of executors are the message can be used for meaningful work. Different types of executors are
supported, each with its own set of restrictions and capabilities. supported, each with its own set of restrictions and capabilities.
Available Executors
===================
.. list-plugins:: oslo.messaging.executors
:detailed:

12
doc/source/notifier.rst
View File

@ -1,6 +1,6 @@
-------- ==========
Notifier Notifier
-------- ==========
.. currentmodule:: oslo_messaging .. currentmodule:: oslo_messaging
@ -12,3 +12,9 @@ Notifier
.. autoclass:: LoggingErrorNotificationHandler .. autoclass:: LoggingErrorNotificationHandler
:members: :members:
Available Notifier Drivers
==========================
.. list-plugins:: oslo.messaging.notify.drivers
:detailed:

3
oslo_messaging/_executors/impl_aioeventlet.py
View File

@ -30,7 +30,7 @@ class AsyncioEventletExecutor(impl_eventlet.EventletExecutor):
To use the executor, an aioeventlet event loop must the running in the To use the executor, an aioeventlet event loop must the running in the
thread executing the executor (usually the main thread). Example of code to thread executing the executor (usually the main thread). Example of code to
setup and run an aioeventlet event loop for the executor (in the main setup and run an aioeventlet event loop for the executor (in the main
thread): thread)::
import aioeventlet import aioeventlet
import trollius import trollius
@ -48,6 +48,7 @@ class AsyncioEventletExecutor(impl_eventlet.EventletExecutor):
# run the event loop in a new greenthread, # run the event loop in a new greenthread,
# close it when it is done # close it when it is done
eventlet.spawn(run_loop, loop) eventlet.spawn(run_loop, loop)
""" """
def __init__(self, conf, listener, dispatcher): def __init__(self, conf, listener, dispatcher):