diff options
| author | Kenneth Giusti <kgiusti@gmail.com> | 2016-09-11 21:07:02 -0400 |
|---|---|---|
| committer | Kenneth Giusti <kgiusti@gmail.com> | 2016-09-12 09:49:00 -0400 |
| commit | 9bc9c0dc6a142540ffb45fb0a9f43cc4aa09e9ac (patch) | |
| tree | bc222a65fab6733b01fb00eb14fa4f6507f5a279 /doc | |
| parent | 6bbe8d1ac64a0e8e560de257efaa4446d27cb946 (diff) | |
| download | oslo-messaging-9bc9c0dc6a142540ffb45fb0a9f43cc4aa09e9ac.tar.gz | |
Fixups to the inline documentation
Rework the inline documentation for executors, RPC servers and
clients, notifiers and notification listeners for clarity and flow.
Change-Id: If4f1db853a7fc85340177fd2c9c43a479d72459d
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/executors.rst | 21 | ||||
| -rw-r--r-- | doc/source/server.rst | 6 |
2 files changed, 21 insertions, 6 deletions
diff --git a/doc/source/executors.rst b/doc/source/executors.rst index 2fde5b8..e7d8a71 100644 --- a/doc/source/executors.rst +++ b/doc/source/executors.rst @@ -2,9 +2,24 @@ Executors ========= -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 -supported, each with its own set of restrictions and capabilities. +Executors control how a received message is scheduled for processing +by a Server. This scheduling can be *synchronous* or *asynchronous*. + +A synchronous executor will process the message on the Server's +thread. This means the Server can process only one message at a time. +Other incoming messages will not be processed until the current +message is done processing. For example, in the case of an RPCServer +only one method call will be invoked at a time. A synchronous +executor guarantees that messages complete processing in the order +that they are received. + +An asynchronous executor will process received messages concurrently. +The Server thread will not be blocked by message processing and can +continue to service incoming messages. There are no ordering +guarantees - message processing may complete in a different order than +they were received. The executor may be configured to limit the +maximum number of messages that are processed at once. + Available Executors =================== diff --git a/doc/source/server.rst b/doc/source/server.rst index 0378d43..f3b3254 100644 --- a/doc/source/server.rst +++ b/doc/source/server.rst @@ -1,6 +1,6 @@ ------- -Server ------- +---------- +RPC Server +---------- .. automodule:: oslo_messaging.rpc.server |