Doc: 'wait' releases driver connection, not 'stop'

This change documents that MessageHandlingServer.wait
the released driver resources associated to this
MessageHandlingServer instance.

Like closing network connections to the broker.

Closes bug: #1397459

Change-Id: I3b0710faeb32ca8e9ee09b14aa1f79290c6061f5
This commit is contained in:
Mehdi Abaakouk 2014-12-03 18:01:46 +01:00
parent 554ad9d035
commit 254405d105
1 changed files with 5 additions and 1 deletions

View File

@ -126,7 +126,8 @@ class MessageHandlingServer(object):
Once this method returns, no new incoming messages will be handled by
the server. However, the server may still be in the process of handling
some messages.
some messages, and underlying driver resources associated to this
server are still in use. See 'wait' for more details.
"""
if self._executor is not None:
self._executor.stop()
@ -137,6 +138,9 @@ class MessageHandlingServer(object):
After calling stop(), there may still be some some existing messages
which have not been completely processed. The wait() method blocks
until all message processing has completed.
Once it's finished, the underlying driver resources associated to this
server are released (like closing useless network connections).
"""
if self._executor is not None:
self._executor.wait()