From 254405d1055df2797723ef175cd56cfe6eb6392f Mon Sep 17 00:00:00 2001
From: Mehdi Abaakouk <mehdi.abaakouk@enovance.com>
Date: Wed, 3 Dec 2014 18:01:46 +0100
Subject: [PATCH] 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
---
oslo/messaging/server.py | 6 +++++-
1 file changed, 5 insertions(+), 1 deletion(-)
diff --git a/oslo/messaging/server.py b/oslo/messaging/server.py
index a5e3477d2..c5c5722a0 100644
--- a/oslo/messaging/server.py
+++ b/oslo/messaging/server.py
@@ -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()