summaryrefslogtreecommitdiff
path: root/Final/python/qpid/queue.py
diff options
context:
space:
mode:
authorRajith Muditha Attapattu <rajith@apache.org>2007-11-19 16:55:10 +0000
committerRajith Muditha Attapattu <rajith@apache.org>2007-11-19 16:55:10 +0000
commit5b7a0ca8896f20c85f176cd178735554833bcefc (patch)
tree255f0b19781a7ea2195a12e2305a3b81680bcac4 /Final/python/qpid/queue.py
parentd66aca6eb24b89052e7e2ab05ade9fcd5398bb95 (diff)
downloadqpid-python-5b7a0ca8896f20c85f176cd178735554833bcefc.tar.gz
Creating the tag for final release
git-svn-id: https://svn.apache.org/repos/asf/incubator/qpid/tags/M2@596364 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'Final/python/qpid/queue.py')
-rw-r--r--Final/python/qpid/queue.py45
1 files changed, 45 insertions, 0 deletions
diff --git a/Final/python/qpid/queue.py b/Final/python/qpid/queue.py
new file mode 100644
index 0000000000..5438b328ab
--- /dev/null
+++ b/Final/python/qpid/queue.py
@@ -0,0 +1,45 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+
+"""
+This module augments the standard python multithreaded Queue
+implementation to add a close() method so that threads blocking on the
+content of a queue can be notified if the queue is no longer in use.
+"""
+
+from Queue import Queue as BaseQueue, Empty, Full
+
+class Closed(Exception): pass
+
+class Queue(BaseQueue):
+
+ END = object()
+
+ def close(self):
+ self.put(Queue.END)
+
+ def get(self, block = True, timeout = None):
+ result = BaseQueue.get(self, block, timeout)
+ if result == Queue.END:
+ # this guarantees that any other waiting threads or any future
+ # calls to get will also result in a Closed exception
+ self.put(Queue.END)
+ raise Closed()
+ else:
+ return result