QPID-2249 Python Headers Exchange Example

git-svn-id: https://svn.apache.org/repos/asf/qpid/trunk/qpid@888452 13f79535-47bb-0310-9956-ffa450edef68

6 files changed, 362 insertions, 0 deletions

diff --git a/python/examples/README b/python/examples/README
index 24d449afc2..bd30b2a6f4 100644
--- a/python/examples/README
+++ b/python/examples/README
@@ -265,3 +265,55 @@ You should see the following output:
 <wind_speed_mph>16</wind_speed_mph><temperature_f>70</temperature_f>
 <dewpoint>35</dewpoint></weather>
 
+
+Running the Headers Examples
+-----------------------------
+
+To run the headers examples, do the following:
+
+1. Make sure that a qpidd broker is running:
+
+ $ ps -eaf | grep qpidd
+
+  If a broker is running, you should see the qpidd process in the output of the above command. 
+
+2.Declare a message queues and bind them to an exchange by running declare_queues.py, as follows:
+
+ $ python declare_queues.py
+
+ This program has no output. After this program has been run, all messages sent to the amq.match exchange with an application-header of {'class': 'first'} will be routed to the queue named "first" and messages with an application-header of {'class': 'second'} will be routed to the queue named "second".
+
+3.Publish a series of messages to the amq.match exchange by running headers_producer.py, as follows:
+
+ $ python headers_producer.py
+
+This program has no output; the messages are routed to the message queues, as instructed by the bindings.
+
+4. Read the messages from the message queues using headers_consumer.py as follows:
+
+ $ python headers_consumer.py
+
+You should see the following output:
+
+message(first) 0
+message(first) 1
+message(first) 2
+message(first) 3
+message(first) 4
+message(first) 5
+message(first) 6
+message(first) 7
+message(first) 8
+message(first) 9
+That's all, folks!
+message(second) 0
+message(second) 1
+message(second) 2
+message(second) 3
+message(second) 4
+message(second) 5
+message(second) 6
+message(second) 7
+message(second) 8
+message(second) 9
+That's all, folks!
diff --git a/python/examples/headers/declare_queues.py b/python/examples/headers/declare_queues.py
new file mode 100755
index 0000000000..b3d5c43fe5
--- /dev/null
+++ b/python/examples/headers/declare_queues.py
@@ -0,0 +1,77 @@
+#!/usr/bin/env python
+#
+# 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.
+#
+"""
+ declare_queues.py 
+
+ Creates and binds a queue on an AMQP headers exchange.
+
+ All messages with an application header of {'class': 'first'} are sent to queue "first".
+ All messages with an application header of {'class': 'second'} are sent to queue "second".
+"""
+
+# Common includes
+
+import qpid
+import sys
+import os
+from qpid.util import connect
+from qpid.connection import Connection
+from qpid.datatypes import Message, RangedSet, uuid4
+from qpid.queue import Empty
+
+#----- Initialization -----------------------------------
+
+#  Set parameters for login
+
+host="127.0.0.1"
+port=5672
+user="guest"
+password="guest"
+
+# If an alternate host or port has been specified, use that instead
+# (this is used in our unit tests)
+if len(sys.argv) > 1 :
+  host=sys.argv[1]
+if len(sys.argv) > 2 :
+  port=int(sys.argv[2])
+
+#  Create a connection.
+socket = connect(host, port)
+connection = Connection (sock=socket, username=user, password=password)
+connection.start()
+session = connection.session(str(uuid4()))
+
+#----- Create queues -------------------------------------
+
+# queue_declare() creates an AMQP queue, which is held
+# on the broker. Published messages are sent to the AMQP queue, 
+# from which messages are delivered to consumers. 
+# 
+# exchange_bind() determines which messages are routed to a queue. 
+
+session.queue_declare(queue="first")
+session.exchange_bind(exchange="amq.match", queue="first", arguments={'x-match':'any', 'class':'first'})
+
+session.queue_declare(queue="second")
+session.exchange_bind(exchange="amq.match", queue="second", arguments={'x-match':'any', 'class':'second'})
+
+#----- Cleanup ---------------------------------------------
+
+session.close(timeout=10)
diff --git a/python/examples/headers/headers_consumer.py b/python/examples/headers/headers_consumer.py
new file mode 100755
index 0000000000..8f5ce3c5ff
--- /dev/null
+++ b/python/examples/headers/headers_consumer.py
@@ -0,0 +1,107 @@
+#!/usr/bin/env python
+#
+# 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.
+#
+"""
+ headers_consumer.py
+
+ This AMQP client reads messages from two message
+ queues named "first" and "second".
+"""
+
+import qpid
+import sys
+import os
+from random import randint
+from qpid.util import connect
+from qpid.connection import Connection
+from qpid.datatypes import Message, RangedSet, uuid4
+from qpid.queue import Empty
+
+
+#----- Initialization --------------------------------------
+
+#  Set parameters for login
+
+host="127.0.0.1"
+port=5672
+user="guest"
+password="guest"
+
+# If an alternate host or port has been specified, use that instead
+# (this is used in our unit tests)
+if len(sys.argv) > 1 :
+  host=sys.argv[1]
+if len(sys.argv) > 2 :
+  port=int(sys.argv[2])
+
+#  Create a connection.
+socket = connect(host, port)
+connection = Connection (sock=socket, username=user, password=password)
+connection.start()
+session = connection.session(str(uuid4()))
+
+#----- Read from queue --------------------------------------------
+
+# Now let's create two local client queues and tell them to read
+# incoming messages.
+
+# The consumer tag identifies the client-side queue.
+
+local_queue_name_first  = "local_queue_first"
+local_queue_name_second = "local_queue_second"
+
+queue_first  = session.incoming(local_queue_name_first)
+queue_second = session.incoming(local_queue_name_second)
+
+# Call message_subscribe() to tell the broker to deliver messages
+# from the AMQP queue to these local client queues. The broker will
+# start delivering messages as soon as credit is allocated using
+# queue.start().
+
+session.message_subscribe(queue="first",  destination=local_queue_name_first)
+session.message_subscribe(queue="second", destination=local_queue_name_second)
+
+queue_first.start()
+queue_second.start()
+
+#  Initialize 'final' and 'content', variables used to identify the last message.
+
+final = "That's all, folks!"   # In a message body, signals the last message
+content = ""		       # Content of the last message read
+
+message = None
+while content != final:
+        message = queue_first.get(timeout=10)
+        content = message.body          
+        session.message_accept(RangedSet(message.id))
+        print content
+
+content = ""
+while content != final:
+        message = queue_second.get(timeout=10)
+        content = message.body          
+        session.message_accept(RangedSet(message.id))
+        print content
+
+#----- Cleanup ------------------------------------------------
+
+# Clean up before exiting so there are no open threads.
+#
+
+session.close(timeout=10)
diff --git a/python/examples/headers/headers_producer.py b/python/examples/headers/headers_producer.py
new file mode 100755
index 0000000000..43130d5993
--- /dev/null
+++ b/python/examples/headers/headers_producer.py
@@ -0,0 +1,79 @@
+#!/usr/bin/env python
+#
+# 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.
+#
+"""
+ headers_producer.py
+
+ Publishes messages to an AMQP headers exchange, using
+ various application header values.
+"""
+
+import qpid
+import sys
+import os
+from qpid.util import connect
+from qpid.connection import Connection
+from qpid.datatypes import Message
+from qpid.datatypes import uuid4
+from qpid.queue import Empty
+
+
+#----- Initialization -----------------------------------
+
+#  Set parameters for login
+
+host="127.0.0.1"
+port=5672
+user="guest"
+password="guest"
+
+# If an alternate host or port has been specified, use that instead
+# (this is used in our unit tests)
+if len(sys.argv) > 1 :
+  host=sys.argv[1]
+if len(sys.argv) > 2 :
+  port=int(sys.argv[2])
+
+#  Create a connection.
+socket = connect(host, port)
+connection = Connection (sock=socket, username=user, password=password)
+connection.start()
+session = connection.session(str(uuid4()))
+
+#----- Publish some messages ------------------------------
+
+# Create some messages and put them on the broker.
+props_first = session.message_properties(application_headers={'class':'first'})
+props_second = session.message_properties(application_headers={'class':'second'})
+props_third = session.message_properties(application_headers={'class':'third'})
+
+for i in range(10):
+     session.message_transfer(destination="amq.match", message=Message(props_first,"message(first) " + str(i)))
+     session.message_transfer(destination="amq.match", message=Message(props_second,"message(second) " + str(i)))
+     session.message_transfer(destination="amq.match", message=Message(props_third,"message(third) " + str(i)))
+
+session.message_transfer(destination="amq.match", message=Message(props_first,"That's all, folks!"))
+session.message_transfer(destination="amq.match", message=Message(props_second,"That's all, folks!"))
+session.message_transfer(destination="amq.match", message=Message(props_third,"That's all, folks!"))
+
+#----- Cleanup --------------------------------------------
+
+# Clean up before exiting so there are no open threads.
+
+session.close(timeout=10)
diff --git a/python/examples/headers/verify b/python/examples/headers/verify
new file mode 100644
index 0000000000..5fe96c5c23
--- /dev/null
+++ b/python/examples/headers/verify
@@ -0,0 +1,22 @@
+#
+# 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.
+#
+
+# See https://svn.apache.org/repos/asf/incubator/qpid/trunk/qpid/bin/verify 
+clients ./declare_queues.py ./headers_producer.py ./headers_consumer.py
+outputs ./declare_queues.py.out ./headers_producer.py.out ./headers_consumer.py.out
diff --git a/python/examples/headers/verify.in b/python/examples/headers/verify.in
new file mode 100644
index 0000000000..90ffd0a071
--- /dev/null
+++ b/python/examples/headers/verify.in
@@ -0,0 +1,25 @@
+==== declare_queues.py.out
+==== headers_producer.py.out
+==== headers_consumer.py.out
+message(first) 0
+message(first) 1
+message(first) 2
+message(first) 3
+message(first) 4
+message(first) 5
+message(first) 6
+message(first) 7
+message(first) 8
+message(first) 9
+That's all, folks!
+message(second) 0
+message(second) 1
+message(second) 2
+message(second) 3
+message(second) 4
+message(second) 5
+message(second) 6
+message(second) 7
+message(second) 8
+message(second) 9
+That's all, folks!