amps-python-client 5.3.4.1__zip

amps-python-client-5.3.4.1/samples/AMPSQueuePublisher.py

@@ -0,0 +1,59 @@
+#!/usr/bin/python
+
+#########################################################################
+# AMPSQueuePublisher
+#
+# This sample connects to AMPS and publishes
+# messages to a queue.
+#
+# The program flow is simple:
+#
+# * Connect to AMPS
+# * Publish a message to a queue
+#
+# This sample doesn't include error handling, high availability, or
+# connection retry logic.
+#########################################################################
+##
+## Copyright (c) 2010-2023 60East Technologies Inc., All Rights Reserved.
+##
+## This computer software is owned by 60East Technologies Inc. and is
+## protected by U.S. copyright laws and other laws and by international
+## treaties.  This computer software is furnished by 60East Technologies
+## Inc. pursuant to a written license agreement and may be used, copied,
+## transmitted, and stored only in accordance with the terms of such
+## license agreement and with the inclusion of the above copyright notice.
+## This computer software or any other copies thereof may not be provided
+## or otherwise made available to any other person.
+##
+## U.S. Government Restricted Rights.  This computer software: (a) was
+## developed at private expense and is in all respects the proprietary
+## information of 60East Technologies Inc.; (b) was not developed with
+## government funds; (c) is a trade secret of 60East Technologies Inc.
+## for all purposes of the Freedom of Information Act; and (d) is a
+## commercial item and thus, pursuant to Section 12.212 of the Federal
+## Acquisition Regulations (FAR) and DFAR Supplement Section 227.7202,
+## Government's use, duplication or disclosure of the computer software
+## is subject to the restrictions set forth by 60East Technologies Inc..
+##
+########################################################################
+
+import AMPS
+import sys
+import os
+
+uri_ = "tcp://127.0.0.1:9027/amps/json"
+
+client = AMPS.Client("QueuePublisher-%s"% os.getpid())
+
+try:
+    client.connect(uri_)
+    client.logon()
+    for i in range (0, 1000): 
+      client.publish("sample-queue", '{ "hi" : "Hello, world! this is message %d"}' % i)
+    
+except AMPS.AMPSException as e:
+    sys.stderr.write(str(e) + "\n")
+
+client.publish_flush(2000)
+client.close()

amps-python-client-5.3.4.1/samples/AMPSSOWConsolePublisher.py

@@ -0,0 +1,67 @@
+#!/usr/bin/python
+
+#########################################################################
+# AMPSSOWConsolePublisher
+#
+# This sample connects to AMPS and publishes
+# messages into a State of the World topic.
+#
+# The program flow is simple:
+#
+# * Connect to AMPS
+# * Publish a set of messages to the topic
+# * Make a change to one message
+#
+# This sample doesn't include error handling, high availability, or
+# connection retry logic.
+#########################################################################
+##
+## Copyright (c) 2010-2023 60East Technologies Inc., All Rights Reserved.
+##
+## This computer software is owned by 60East Technologies Inc. and is
+## protected by U.S. copyright laws and other laws and by international
+## treaties.  This computer software is furnished by 60East Technologies
+## Inc. pursuant to a written license agreement and may be used, copied,
+## transmitted, and stored only in accordance with the terms of such
+## license agreement and with the inclusion of the above copyright notice.
+## This computer software or any other copies thereof may not be provided
+## or otherwise made available to any other person.
+##
+## U.S. Government Restricted Rights.  This computer software: (a) was
+## developed at private expense and is in all respects the proprietary
+## information of 60East Technologies Inc.; (b) was not developed with
+## government funds; (c) is a trade secret of 60East Technologies Inc.
+## for all purposes of the Freedom of Information Act; and (d) is a
+## commercial item and thus, pursuant to Section 12.212 of the Federal
+## Acquisition Regulations (FAR) and DFAR Supplement Section 227.7202,
+## Government's use, duplication or disclosure of the computer software
+## is subject to the restrictions set forth by 60East Technologies Inc..
+##
+########################################################################
+
+import AMPS
+import sys
+import time
+import os
+
+uri_ = "tcp://127.0.0.1:9027/amps/json"
+client = AMPS.Client("exampleSOWPublisher-%s" % os.getpid())
+
+try:
+    client.connect(uri_)
+    client.logon()
+    
+    for number in range(0,99):
+        client.publish("messages-sow", \
+                       '{ "text":"Hello, world!", "messageNumber": %d }' \
+                       % number)
+
+    
+    #now make a change to message 5
+    client.publish("messages-sow", \
+                   '{ "text":"This is new information", "messageNumber":5 }')
+    
+except AMPS.AMPSException as e:
+    sys.stderr.write(str(e) + "\n")
+
+client.close()

amps-python-client-5.3.4.1/samples/AMPSSOWConsoleSubscriber.py

@@ -0,0 +1,77 @@
+#!/usr/bin/python
+
+#########################################################################
+# AMPSSOWConsoleSubscriber
+#
+# This sample runs a SOW query and receives the results. The sample prints
+# each message as it is received.
+#
+# The program flow is simple:
+#
+# * Connect to AMPS
+# * Execute a SOW command, which runs a query for the current values in
+#   the topic.
+# * Print the content of each message as it is received
+#
+# This sample doesn't include error handling, high availability, or
+# connection retry logic.
+#########################################################################
+##
+## Copyright (c) 2010-2023 60East Technologies Inc., All Rights Reserved.
+##
+## This computer software is owned by 60East Technologies Inc. and is
+## protected by U.S. copyright laws and other laws and by international
+## treaties.  This computer software is furnished by 60East Technologies
+## Inc. pursuant to a written license agreement and may be used, copied,
+## transmitted, and stored only in accordance with the terms of such
+## license agreement and with the inclusion of the above copyright notice.
+## This computer software or any other copies thereof may not be provided
+## or otherwise made available to any other person.
+##
+## U.S. Government Restricted Rights.  This computer software: (a) was
+## developed at private expense and is in all respects the proprietary
+## information of 60East Technologies Inc.; (b) was not developed with
+## government funds; (c) is a trade secret of 60East Technologies Inc.
+## for all purposes of the Freedom of Information Act; and (d) is a
+## commercial item and thus, pursuant to Section 12.212 of the Federal
+## Acquisition Regulations (FAR) and DFAR Supplement Section 227.7202,
+## Government's use, duplication or disclosure of the computer software
+## is subject to the restrictions set forth by 60East Technologies Inc..
+##
+########################################################################
+
+
+
+import AMPS
+import sys
+import time
+import os
+
+uri_ = "tcp://127.0.0.1:9027/amps/json"
+
+try:
+    client = AMPS.Client("exampleSOWQuery-%s" % os.getpid())
+    client.connect(uri_)
+    client.logon()
+
+    # Query the current state of the messages-sow topic
+    # for any messages where the messageNumber field is
+    # less than 10.
+
+    # The loop exits when all of matching messages are
+    # retrieved.
+        
+    for message in client.sow(topic="messages-sow",
+                              filter="/messageNumber < 10"):
+       if (message.get_command() == message.Command.GroupBegin):
+           print("Receiving messages from the SOW.")
+           continue
+
+       if (message.get_command() == message.Command.GroupEnd):
+           print("Done receiving messages from the SOW.")
+           continue
+
+       print(message.get_data())
+
+except AMPS.AMPSException as e:
+    sys.stderr.write(str(e) + "\n")

amps-python-client-5.3.4.1/samples/AMPSSOWandSubscribeConsoleSubscriber.py

@@ -0,0 +1,79 @@
+#!/usr/bin/python
+
+#########################################################################
+# AMPSSOWandSubcribeConsoleSubscriber
+#
+# This sample runs a SOW query and enters an atomic subscription
+# at the same time. The sample receives the results from the query, then
+# receives new messages published to the topic.
+# The sample prints each message as it is received, and also indicates
+# where the SOW query begins and ends. For demonstration purposes, the
+# sample also shows the command value of each message. For messages
+# received as part of the SOW query, the command is "sow". For messages
+# received from the subscription, the command is "publish".
+
+# The program flow is simple:
+#
+# * Connect to AMPS
+# * Execute a SOW and Subscribe command, which runs a query and
+#   subscribes to the topic in a single atomic operation
+# * Print the content of each message as it is received
+#
+# This sample doesn't include error handling, high availability, or
+# connection retry logic.
+#########################################################################
+##
+## Copyright (c) 2010-2023 60East Technologies Inc., All Rights Reserved.
+##
+## This computer software is owned by 60East Technologies Inc. and is
+## protected by U.S. copyright laws and other laws and by international
+## treaties.  This computer software is furnished by 60East Technologies
+## Inc. pursuant to a written license agreement and may be used, copied,
+## transmitted, and stored only in accordance with the terms of such
+## license agreement and with the inclusion of the above copyright notice.
+## This computer software or any other copies thereof may not be provided
+## or otherwise made available to any other person.
+##
+## U.S. Government Restricted Rights.  This computer software: (a) was
+## developed at private expense and is in all respects the proprietary
+## information of 60East Technologies Inc.; (b) was not developed with
+## government funds; (c) is a trade secret of 60East Technologies Inc.
+## for all purposes of the Freedom of Information Act; and (d) is a
+## commercial item and thus, pursuant to Section 12.212 of the Federal
+## Acquisition Regulations (FAR) and DFAR Supplement Section 227.7202,
+## Government's use, duplication or disclosure of the computer software
+## is subject to the restrictions set forth by 60East Technologies Inc..
+##
+########################################################################
+
+import AMPS
+import sys
+import time
+import os
+
+uri_ = "tcp://127.0.0.1:9027/amps/json"
+client = AMPS.Client("exampleSOWandSubscribeQuery-%s" % os.getpid())
+
+try:
+    client.connect(uri_)
+    client.logon()
+
+    # Run a SOW query and enter an atomic subscription. The loop
+    # receives all of the messages from the SOW and then
+    # recieves messages from the subscription.
+    
+    for message in client.sow_and_subscribe(topic="messages-sow",
+                                            filter="/messageNumber < 10"):
+       if (message.get_command() == message.Command.GroupBegin):
+           print("Receiving messages from the SOW.")
+           continue
+       if (message.get_command() == message.Command.GroupEnd):
+           print("Done receiving messages from the SOW.")
+           continue
+
+       print ("(%s) : %s" % (message.get_command() , message.get_data_raw()))
+
+except AMPS.AMPSException as e:
+    sys.stderr.write(str(e) + "\n")
+
+client.close()

amps-python-client-5.3.4.1/samples/AMPSSOWandSubscribeWithOOF.py

@@ -0,0 +1,108 @@
+#!/usr/bin/python
+
+#########################################################################
+# AMPSSOWandSubscribeWithOOF
+#
+# This sample runs a SOW query and enters an atomic subscription
+# at the same time. The sample receives the results from the query, then
+# receives new messages published to the topic. The sample requests OOF
+# notifications when a message which previously matched the subscription
+# no longer matches the subscription.
+#
+# The sample prints each message as it is received, and also indicates
+# where the SOW query begins and ends. For demonstration purposes, the
+# sample also shows the command value of each message. For messages
+# received as part of the SOW query, the command is "sow". For messages
+# received from the subscription, the command is "publish". For messages
+# that no longer match, the command is "oof".
+
+# The program flow is:
+#
+# * Connect to AMPS
+# * Execute a SOW and Subscribe command, which runs a query and
+#   subscribes to the topic in a single atomic operation
+# * Print the content of each message as it is received
+#   - For SOW results or published messages, print the message data
+#   - For group_begin and group_end messages, print an informative message
+#   - For OOF messages, print the reason for the OOF and the message which
+#     no longer matches
+#
+# This sample doesn't include error handling, high availability, or
+# connection retry logic.
+#########################################################################
+##
+## Copyright (c) 2010-2023 60East Technologies Inc., All Rights Reserved.
+##
+## This computer software is owned by 60East Technologies Inc. and is
+## protected by U.S. copyright laws and other laws and by international
+## treaties.  This computer software is furnished by 60East Technologies
+## Inc. pursuant to a written license agreement and may be used, copied,
+## transmitted, and stored only in accordance with the terms of such
+## license agreement and with the inclusion of the above copyright notice.
+## This computer software or any other copies thereof may not be provided
+## or otherwise made available to any other person.
+##
+## U.S. Government Restricted Rights.  This computer software: (a) was
+## developed at private expense and is in all respects the proprietary
+## information of 60East Technologies Inc.; (b) was not developed with
+## government funds; (c) is a trade secret of 60East Technologies Inc.
+## for all purposes of the Freedom of Information Act; and (d) is a
+## commercial item and thus, pursuant to Section 12.212 of the Federal
+## Acquisition Regulations (FAR) and DFAR Supplement Section 227.7202,
+## Government's use, duplication or disclosure of the computer software
+## is subject to the restrictions set forth by 60East Technologies Inc..
+##
+########################################################################
+
+import AMPS
+import sys
+import time
+import os
+
+uri_ = "tcp://127.0.0.1:9027/amps/json"
+
+
+# main program
+#
+# Create a client, connect to the server, query the SOW,
+# and then wait for the callback function to process messages.
+client = AMPS.Client("exampleSOWandSubscribeQueryWithOOF-%s"% os.getpid())
+
+try:
+    client.connect(uri_)
+    client.logon()
+   
+    # Query for messages in the messages-sow topic.
+
+    # When messages are received, AMPS will invoke the
+    # handleMessage function, providing the message and
+    # as a parameter.
+
+    # Because oof_enabled is true, AMPS will provide
+    # an OOF message when a message that had previously matched the filter
+    # no longer matches the filter.
+ 
+    for message in client.sow_and_subscribe(topic="messages-sow",
+                filter="/messageNumber % 10  = 0 " +
+                "AND (/OptionalField IS NULL OR /OptionalField <> 'ignore_me')",
+                oof_enabled="true"):
+
+      if (message.get_command() == message.Command.OOF):
+          print("Received an OOF.")
+          print("   " + message.get_reason() + " : %s" %  message.get_data_raw())
+          continue
+
+      if (message.get_command() == message.Command.GroupBegin):
+          print("Receiving messages from the SOW.")
+          continue
+
+      if (message.get_command() == message.Command.GroupEnd):
+          print("Done receiving messages from the SOW.")
+
+      print(message.get_data_raw())
+
+
+except AMPS.AMPSException as e:
+    sys.stderr.write(str(e) + "\n")
+
+client.close()

amps-python-client-5.3.4.1/samples/AMPSSubscribeForReplay.py

@@ -0,0 +1,128 @@
+#!/usr/bin/python
+
+#########################################################################
+# AMPSSubscribeForReplay
+
+# This sample subscribes to a topic in AMPS that maintains a transaction
+# log, and requests replay from the transaction log.
+#
+# The program flow is simple:
+#
+# * Connect to AMPS
+# * Logon
+# * Request replay from the "messages-history" topic from the last
+#   message received.
+#
+# To understand this program, start with the subscribe method of the
+# bookmark_subscriber.
+#
+#########################################################################
+##
+## Copyright (c) 2010-2023 60East Technologies Inc., All Rights Reserved.
+##
+## This computer software is owned by 60East Technologies Inc. and is
+## protected by U.S. copyright laws and other laws and by international
+## treaties.  This computer software is furnished by 60East Technologies
+## Inc. pursuant to a written license agreement and may be used, copied,
+## transmitted, and stored only in accordance with the terms of such
+## license agreement and with the inclusion of the above copyright notice.
+## This computer software or any other copies thereof may not be provided
+## or otherwise made available to any other person.
+##
+## U.S. Government Restricted Rights.  This computer software: (a) was
+## developed at private expense and is in all respects the proprietary
+## information of 60East Technologies Inc.; (b) was not developed with
+## government funds; (c) is a trade secret of 60East Technologies Inc.
+## for all purposes of the Freedom of Information Act; and (d) is a
+## commercial item and thus, pursuant to Section 12.212 of the Federal
+## Acquisition Regulations (FAR) and DFAR Supplement Section 227.7202,
+## Government's use, duplication or disclosure of the computer software
+## is subject to the restrictions set forth by 60East Technologies Inc..
+##
+########################################################################
+
+import AMPS
+import sys
+import time
+import os
+
+uri_ = "tcp://127.0.0.1:9027/amps/json"
+
+client = AMPS.HAClient("exampleSubscriberWithReplay-%s" % os.getpid())
+
+message_count = 0
+
+# Handler for received messages.
+#
+# Prints the received message to the console and 
+# discards the message from the bookmark store.
+
+def onMessagePrinter(message):
+    global message_count
+    message_count += 1
+    print (message.get_data_raw())
+
+    # Discard the message. This tells the bookmark store that the
+    # message has been processed, and does not need to be requested
+    # again.
+    client.discard(message)
+
+    # After 10 messages, exit the program
+    if (message_count >= 10):
+       exit(0)
+
+# onExceptionHandler
+#
+# Receives any exceptions thrown by the message processor. For demonstration
+# purposes, the handler prints the exception and continues.
+
+def onExceptionHandler(e):
+    sys.stderr.write(str(e) + "\n")
+
+# Main section of the program.
+
+try:
+
+    # Create a server chooser. For demonstration purposes, only include
+    # the URI to the sample AMPS instance.
+    
+    chooser = AMPS.DefaultServerChooser()
+    chooser.add(uri_)
+    client.set_server_chooser(chooser) 
+
+    # Create file-backed bookmark store, using "bookmarks" as the file
+    # name. 
+
+    bookmarks = AMPS.MMapBookmarkStore("bookmarks")
+    client.set_bookmark_store(bookmarks)
+
+    # Set the exception listener.
+
+    client.set_exception_listener(onExceptionHandler)
+
+    # The client is now prepared for use. Connect and logon.
+
+    client.connect_and_logon()
+
+
+    # Enter the subscription. This statement requests all
+    # messages that have not been previously processed on
+    # the "messages-history" topic.
+
+    client.bookmark_subscribe(onMessagePrinter, \
+                              "messages-history", \
+                              client.Bookmarks.MOST_RECENT)
+
+    # All of the work happens on a background thread. Sleep on
+    # the main thread.
+
+    # Loop until the background thread receives 10 messages,
+    # or until the program begins exiting (and message_count is destroyed).
+    while message_count != None and message_count<10:
+        time.sleep(.5)
+    exit() 
+
+except AMPS.AMPSException as e:
+    sys.stderr.write(str(e) + "\n")
+
+client.close()

amps-python-client-5.3.4.1/samples/AMPSUpdateForOOF.py

@@ -0,0 +1,123 @@
+#!/usr/bin/python
+
+#########################################################################
+# AMPSUpdateForOOF
+
+# This sample publishes messages to a SOW topic, then updates
+# the message in a way that will cause AMPS to deliver OOF
+# messages to the sample program that requests OOF notifications.
+
+# The program flow is:
+#
+# * Connect to AMPS
+# * Logon
+# * Publish a message with expiration set
+# * Publish a message to be deleted later
+# * Publish a set of messages
+# * Publish updates to some of those messages
+# * Delete the message published to be deleted
+
+# During this process, the sample program that receives OOF notifications
+# will receive OOF messages for updates, for an expiration, and for a
+# deleted message.
+
+#########################################################################
+##
+## Copyright (c) 2010-2023 60East Technologies Inc., All Rights Reserved.
+##
+## This computer software is owned by 60East Technologies Inc. and is
+## protected by U.S. copyright laws and other laws and by international
+## treaties.  This computer software is furnished by 60East Technologies
+## Inc. pursuant to a written license agreement and may be used, copied,
+## transmitted, and stored only in accordance with the terms of such
+## license agreement and with the inclusion of the above copyright notice.
+## This computer software or any other copies thereof may not be provided
+## or otherwise made available to any other person.
+##
+## U.S. Government Restricted Rights.  This computer software: (a) was
+## developed at private expense and is in all respects the proprietary
+## information of 60East Technologies Inc.; (b) was not developed with
+## government funds; (c) is a trade secret of 60East Technologies Inc.
+## for all purposes of the Freedom of Information Act; and (d) is a
+## commercial item and thus, pursuant to Section 12.212 of the Federal
+## Acquisition Regulations (FAR) and DFAR Supplement Section 227.7202,
+## Government's use, duplication or disclosure of the computer software
+## is subject to the restrictions set forth by 60East Technologies Inc..
+##
+########################################################################
+import AMPS
+import sys
+import time
+import os
+
+uri_ = "tcp://127.0.0.1:9027/amps/json"
+
+# deletedMessageAck
+#
+# This function receives the acknowledgement message that results from
+# deleting a message from the SOW. For sample purposes, this program
+# ignores the contents of the message.
+
+def deletedMessageAck(message):
+    pass
+
+
+# main program
+#
+# Connect to AMPS, send a message with an expiration, and send a message that
+# will be deleted. After that, send a set of messages and update the messages.
+client = AMPS.Client("exampleSOWUpdater-%s" % os.getpid())
+
+try:
+    client.connect(uri_)
+    client.logon()
+
+    # Publish a message with the expiration set.
+    m = client.allocate_message()
+    m.set_expiration("1")
+    m.set_command("publish")
+    m.set_topic("messages-sow")
+    m.set_data('{"messageNumber" :50000, "message" : "Here and then gone..."}')
+
+    client.send(m)
+
+    # Publish a message to be deleted later on.
+
+    client.publish("messages-sow", \
+                   '{"messageNumber":500,' + \
+                      '"message":"I\'ve got a bad feeling about this..."}')
+
+    # Publish two sets of messages, the first one to match
+    # the subscriber filter, the next one to make messages no longer
+    # match the subscriber filter.
+
+    # The first set of messages is designed so that, if this is run
+    # after the previous SOW example, the sample with OOF tracking
+    # recieves an updated message.
+ 
+    for number in range(0,10000,1250):
+        client.publish("messages-sow",
+                       '{"message":"Hello, you crazy world!"' +
+                         ',"messageNumber":%i' % number +
+                       ',"OptionalField":"true"}')
+
+
+    # The second set of messages will cause OOF messages for the sample
+    # that uses OOF tracking.
+
+    for number in range(0,10000,1250): 
+        client.publish("messages-sow",
+                       '{"message":"Updated, world!"' +
+                       ',"messageNumber":%i' % number+
+                       ',"OptionalField":"ignore_me"}') 
+
+
+    # Delete the message published earlier
+
+    client.sow_delete(deletedMessageAck, "messages-sow", \
+                         "/messageNumber = 500", 0)
+    
+except AMPS.AMPSException as e:
+    sys.stderr.write(str(e) + "\n")
+
+client.close()