amps-python-client 5.3.4.1__zip → 5.3.4.2__zip

amps-python-client-5.3.4.2/src/ringbookmarkstore.cpp

@@ -0,0 +1,360 @@
+////////////////////////////////////////////////////////////////////////////
+//
+// Copyright (c) 2010-2024 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..
+//
+////////////////////////////////////////////////////////////////////////////
+
+#define PY_SSIZE_T_CLEAN 1
+#include <Python.h>
+#include <amps/ampsplusplus.hpp>
+#include <ampspy_types.hpp>
+#include <ampspy_defs.hpp>
+
+using namespace AMPS;
+namespace ampspy
+{
+  namespace ringbookmarkstore
+  {
+
+    static void* __ctor(obj* self, PyObject* args, PyObject* kwds)
+    {
+      char* filename;
+      if (!PyArg_ParseTuple(args, "s", &filename))
+      {
+        return NULL;
+      }
+      self->impl = 0;
+      try
+      {
+        self->impl = new BookmarkStore(new RingBookmarkStore(filename));
+      } DISPATCH_EXCEPTION;
+      return (void*)filename;
+    }
+
+//    def __init__(self, name):
+    static int _ctor(obj* self, PyObject* args, PyObject* kwds)
+    {
+      if (__ctor(self, args, kwds) == NULL)
+      {
+        return -1;
+      }
+      return 0;
+    }
+
+    static void _dtor(obj* self)
+    {
+      {
+        UNLOCKGIL;
+        delete self->impl;
+      }
+      Py_XDECREF(self->resizeHandler);
+      shims::free(self);
+    }
+
+    static PyObject*
+    log(obj* self, PyObject* args)
+    {
+      ampspy::message::obj* pPythonMessage = NULL;
+      if (!PyArg_ParseTuple(args, "O!",
+                            ampspy::message::message_type.pPyObject(),
+                            &pPythonMessage))
+      {
+        return NULL;
+      }
+
+      AMPS::Message* pMessage = pPythonMessage->pMessage;
+
+      CALL_RETURN_SIZE_T(self->impl->log(*pMessage));
+    }
+
+    static PyObject*
+    discard_message(obj* self, PyObject* args)
+    {
+      ampspy::message::obj* pPythonMessage = NULL;
+      if (!PyArg_ParseTuple(args, "O!",
+                            ampspy::message::message_type.pPyObject(),
+                            &pPythonMessage))
+      {
+        return NULL;
+      }
+
+      AMPS::Message* pMessage = pPythonMessage->pMessage;
+
+      CALL_RETURN_NONE(self->impl->discard(*pMessage));
+    }
+
+    static PyObject*
+    discard(obj* self, PyObject* args)
+    {
+      const char*           subId       = NULL;
+      Py_ssize_t            subIdLength = 0;
+      unsigned PY_LONG_LONG sequence    = 0;
+
+      if (!PyArg_ParseTuple(args, "s#K",
+                            &subId,
+                            &subIdLength,
+                            &sequence))
+      {
+        return NULL;
+      }
+
+      CALL_RETURN_NONE(self->impl->discard(AMPS::Field(subId, subIdLength),
+                                           (size_t)sequence));
+    }
+
+    static PyObject*
+    get_most_recent(obj* self, PyObject* args)
+    {
+      const char*  subId          = NULL;
+      Py_ssize_t   subIdLength    = 0;
+
+      if (!PyArg_ParseTuple(args, "s#",
+                            &subId,
+                            &subIdLength))
+      {
+        return NULL;
+      }
+
+      CALL_RETURN_FIELD(self->impl->getMostRecent(
+                          AMPS::Field(subId, subIdLength)));
+    }
+
+    static PyObject*
+    is_discarded(obj* self, PyObject* args)
+    {
+      ampspy::message::obj* pPythonMessage = NULL;
+      if (!PyArg_ParseTuple(args, "O!",
+                            ampspy::message::message_type.pPyObject(),
+                            &pPythonMessage))
+      {
+        return NULL;
+      }
+
+      AMPS::Message* pMessage = pPythonMessage->pMessage;
+      CALL_RETURN_BOOL(self->impl->isDiscarded(*pMessage));
+    }
+
+    static PyObject*
+    persisted(obj* self, PyObject* args)
+    {
+      const char*  subId          = NULL;
+      Py_ssize_t   subIdLength    = 0;
+      const char*  bookmark       = NULL;
+      Py_ssize_t   bookmarkLength = 0;
+
+      if (!PyArg_ParseTuple(args, "s#s#",
+                            &subId,
+                            &subIdLength,
+                            &bookmark,
+                            &bookmarkLength))
+      {
+        return NULL;
+      }
+
+      CALL_RETURN_NONE(self->impl->persisted(
+                         AMPS::Field(subId, subIdLength),
+                         AMPS::Field(bookmark, bookmarkLength)));
+    }
+
+    static PyObject*
+    persisted_index(obj* self, PyObject* args)
+    {
+      const char*           subId          = NULL;
+      Py_ssize_t            subIdLength    = 0;
+      unsigned PY_LONG_LONG bookmark       = 0;
+
+      if (!PyArg_ParseTuple(args, "s#K",
+                            &subId,
+                            &subIdLength,
+                            &bookmark))
+      {
+        return NULL;
+      }
+
+      CALL_RETURN_NONE(self->impl->persisted(
+                         AMPS::Field(subId, subIdLength),
+                         (size_t)bookmark));
+    }
+
+    static PyObject*
+    purge(obj* self, PyObject* args)
+    {
+      CALL_RETURN_NONE(self->impl->purge());
+    }
+
+    static PyObject*
+    purge_sub_id(obj* self, PyObject* args)
+    {
+      const char*           subId       = NULL;
+      Py_ssize_t            subIdLength = 0;
+
+      if (!PyArg_ParseTuple(args, "s#",
+                            &subId,
+                            &subIdLength))
+      {
+        return NULL;
+      }
+
+      CALL_RETURN_NONE(self->impl->purge(AMPS::Field(subId, subIdLength)));
+    }
+
+    static PyObject*
+    get_oldest_bookmark_seq(obj* self, PyObject* args)
+    {
+      const char*  subId          = NULL;
+      Py_ssize_t   subIdLength    = 0;
+
+      if (!PyArg_ParseTuple(args, "s#",
+                            &subId,
+                            &subIdLength))
+      {
+        return NULL;
+      }
+
+      CALL_RETURN_SIZE_T(self->impl->getOldestBookmarkSeq(
+                           AMPS::Field(subId, subIdLength)));
+    }
+
+    static PyObject*
+    set_server_version(obj* self, PyObject* args)
+    {
+      unsigned PY_LONG_LONG version = 0;
+
+      if (!PyArg_ParseTuple(args, "K",
+                            &version))
+      {
+        return NULL;
+      }
+
+      CALL_RETURN_NONE(self->impl->setServerVersion((size_t)version));
+    }
+
+    bool
+    call_resize_handler(BookmarkStoreImpl* store, const Message::Field& subId,  size_t size, void* vp)
+    {
+      LOCKGIL;
+      obj* s = (obj*)vp;
+      PyObject* pySubId = PyString_FromStringAndSize(subId.data(), subId.len());
+#if defined(_WIN32) && !defined(_WIN64)
+      PyObject* args = Py_BuildValue("(OiO)", s, size, pySubId);
+#else
+      PyObject* args = Py_BuildValue("(OlO)", s, size, pySubId);
+#endif
+      PyObject* pyRet = PyObject_Call(s->resizeHandler, args, (PyObject*)NULL);
+      Py_DECREF(args);
+      if (pyRet == NULL || PyErr_Occurred())
+      {
+        Py_XDECREF(pyRet);
+        if (PyErr_ExceptionMatches(PyExc_SystemExit))
+        {
+          ampspy::unhandled_exception();
+        }
+        throw StoreException("The bookmark resize handler threw an exception");
+      }
+      bool ret = (PyObject_IsTrue(pyRet) != 0);
+      Py_DECREF(pyRet);
+      return ret;
+    }
+
+    static PyObject* set_resize_handler(obj* self, PyObject* args)
+    {
+      PyObject* callable;
+      if (!PyArg_ParseTuple(args, "O", &callable))
+      {
+        return NULL;
+      }
+      if (!PyCallable_Check(callable))
+      {
+        PyErr_SetString(PyExc_TypeError, "argument must be callable.");
+        return NULL;
+      }
+      Py_INCREF(callable);
+      Py_XDECREF(self->resizeHandler);
+      self->resizeHandler = callable;
+      CALL_RETURN_NONE(self->impl->setResizeHandler((AMPS::BookmarkStoreResizeHandler)call_resize_handler, self));
+    }
+
+    AMPSDLL ampspy::ampspy_type_object ringbookmarkstore_type;
+
+    void add_types(PyObject* module_)
+    {
+      ringbookmarkstore_type.setName("AMPS.RingBookmarkStore")
+      .setBasicSize(sizeof(obj))
+      .setDestructorFunction(_dtor)
+      .setConstructorFunction(_ctor)
+      .setBaseType()
+      .setDoc("AMPS RingBookmarkStore Object")
+      .notCopyable()
+      .addMethod("log", log,
+                 "log(message)\n\n"
+                 "Log a bookmark to the log and return the corresponding sequence "
+                 "number.\n")
+      .addMethod("discard_message", discard_message,
+                 "discard_message(message)\n\n"
+                 "Log a message as discarded from the store.\n")
+      .addMethod("discard", discard,
+                 "discard(subid,sequence)\n\n"
+                 "Log a discard-bookmark entry to the persisted log.")
+      .addMethod("get_most_recent", get_most_recent,
+                 "get_most_recent(subid)\n\n"
+                 "Returns the most recent bookmark from the log that ought to be used\n"
+                 "for (re-)subscriptions.\n")
+      .addMethod("is_discarded", is_discarded,
+                 "is_discarded(message)\n\n"
+                 "Called for each arriving message to determine if the application has\n"
+                 "already seen this bookmark and should not be reprocessed. Returns\n"
+                 "True if the bookmark is in the log and should not be re-processed,\n"
+                 "False otherwise.\n")
+      .addMethod("persisted", persisted,
+                 "persisted(subid, bookmark)\n\n"
+                 "Mark all bookmarks up to the provided one as replicated to all\n"
+                 "replication destinations for the given subscription.\n")
+      .addMethod("persisted_index", persisted_index,
+                 "persisted(subid, bookmark_index)\n\n"
+                 "Mark all bookmarks up to the provided index as replicated to all\n"
+                 "replication destinations for the given subscription.\n")
+      .addMethod("purge", purge,
+                 "purge()\n\n"
+                 "Called to purge the contents of this store. Removes any tracking\n"
+                 "history associated with publishers and received messages, and may\n"
+                 "delete or truncate on-disk representations as well.\n")
+      .addMethod("purge_sub_id", purge_sub_id,
+                 "purge_sub_id()\n\n"
+                 "Called to purge the contents of this store for a given subscription\n"
+                 "id. Removes any tracking history associated with publishers and \n"
+                 "received messages, and may delete or truncate on-disk representations\n"
+                 "as well.\n")
+      .addMethod("get_oldest_bookmark_seq", get_oldest_bookmark_seq,
+                 "get_oldest_bookmark_seq(subid)\n\n"
+                 "Called to find the oldest bookmark sequence in the store.\n")
+      .addMethod("set_server_version", set_server_version,
+                 "set_server_version(version)\n\n"
+                 "Internally used to set the server version so the store knows how to\n"
+                 "deal with persisted acks and calls to get_most_recent().\n")
+      .addMethod("set_resize_handler", set_resize_handler, "set_resize_handler()\n\nSets the object to call when the store needs to resize.\n")
+      .createType()
+      .registerType("RingBookmarkStore", module_);
+
+    }
+
+  } // namespace ringbookmarkstore
+} // namespace ampspy

amps-python-client-5.3.4.2/src/serverchooser.cpp

@@ -0,0 +1,245 @@
+////////////////////////////////////////////////////////////////////////////
+//
+// Copyright (c) 2010-2024 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..
+//
+////////////////////////////////////////////////////////////////////////////
+
+#define PY_SSIZE_T_CLEAN 1
+#include <Python.h>
+#include <amps/ampsplusplus.hpp>
+#include <ampspy_types.hpp>
+#include <ampspy_defs.hpp>
+
+#include "serverchooser_docs.h"
+
+using namespace AMPS;
+namespace ampspy
+{
+  namespace serverchooser
+  {
+
+//    def __init__(self, name):
+    static int ctor(obj* self, PyObject* args, PyObject* kwds)
+    {
+      self->impl = new AMPS::DefaultServerChooser();
+      return 0;
+    }
+    static void dtor(obj* self)
+    {
+      delete self->impl;
+      shims::free(self);
+    }
+
+#define M(x,desc) { #x, (PyCFunction)&x,METH_VARARGS, desc}
+#define M2(x,x2,desc) { x2, (PyCFunction)&x,METH_VARARGS, desc}
+#define MK(x,desc) { #x, (PyCFunction)&x,METH_VARARGS|METH_KEYWORDS, desc}
+#define MK2(x,x2,desc) { x2, (PyCFunction)&x,METH_VARARGS|METH_KEYWORDS, desc}
+
+    static PyObject* add(obj* self, PyObject* args)
+    {
+      const char* uri;
+      if (!PyArg_ParseTuple(args, "s", &uri))
+      {
+        return NULL;
+      }
+
+      self->impl->add(uri);
+      NONE;
+    }
+
+    class PyListContainer
+    {
+    public:
+      class const_iterator
+      {
+      public:
+        const char* operator*()
+        {
+          PyObject* strObj = PyList_GetItem(_list, _next);
+          if (PyString_Check(strObj))
+          {
+            return PyString_AsString(strObj);
+          }
+          return NULL;
+        }
+        const_iterator& operator++()
+        {
+          ++_next;
+          return *this;
+        }
+        bool operator!=(const const_iterator& rhs_) const
+        {
+          return _next != rhs_._next || _list != rhs_._list;
+        }
+        bool operator==(const const_iterator& rhs_) const
+        {
+          return _next == rhs_._next && _list == rhs_._list;
+        }
+        const_iterator(PyObject* list_, bool end_ = false)
+          : _list(list_), _next(0)
+        {
+          if (end_)
+          {
+            _next = PyList_Size(_list);
+          }
+        }
+      private:
+        PyObject* _list;
+        size_t _next;
+      };
+      PyListContainer(PyObject* list_) : _list(list_) {}
+      const_iterator begin() const
+      {
+        return const_iterator(_list);
+      }
+      const_iterator end() const
+      {
+        return const_iterator(_list, true);
+      }
+    private:
+      PyObject* _list;
+    };
+
+    static PyObject* add_all(obj* self, PyObject* args)
+    {
+      PyObject* list;
+      if (!PyArg_ParseTuple(args, "O", &list))
+      {
+        return NULL;
+      }
+      if (!PyList_Check(list))
+      {
+        PyErr_SetString(PyExc_TypeError, "list required for argument.");
+        return NULL;
+      }
+      PyListContainer container(list);
+      self->impl->addAll(container);
+      NONE;
+    }
+
+    static PyObject* get_current_uri(obj* self, PyObject* args)
+    {
+      return ret(self->impl->getCurrentURI());
+    }
+
+    static PyObject* get_current_authenticator(obj* self, PyObject* args)
+    {
+      NONE;
+    }
+
+    std::map<std::string, std::string>
+    string_map_from_dictionary(PyObject* dictionary)
+    {
+      std::map<std::string, std::string> returnValue;
+      Py_ssize_t pos = 0;
+      PyObject* key, *value;
+      while (PyDict_Next(dictionary, &pos, &key, &value))
+      {
+        returnValue[PyString_AsString(key)] = PyString_AsString(value);
+      }
+      return returnValue;
+    }
+
+
+    static PyObject* report_failure(obj* self, PyObject* args)
+    {
+      PyObject* ex, *dict;
+      if (!PyArg_ParseTuple(args, "OO", &ex, &dict))
+      {
+        return NULL;
+      }
+      if (!PyDict_Check(dict))
+      {
+        PyErr_SetString(PyExc_TypeError, "dictionary required for argument 2.");
+        return NULL;
+      }
+
+      PyObject* ex_as_string = PyObject_Str(ex);
+      std::string message(PyString_AsString(ex_as_string));
+      Py_XDECREF(ex_as_string);
+
+      // map the python dictionary to a ConnectionInfo
+      ConnectionInfo ci = string_map_from_dictionary(dict);
+
+      self->impl->reportFailure(ConnectionException(message, AMPS_E_CONNECTION), ci);
+      NONE;
+    }
+
+    static PyObject* get_error(obj* self, PyObject* args)
+    {
+      return ret(self->impl->getError());
+    }
+
+    static PyObject* report_success(obj* self, PyObject* args)
+    {
+      PyObject* dict;
+      if (!PyArg_ParseTuple(args, "O", &dict))
+      {
+        return NULL;
+      }
+      if (!PyDict_Check(dict))
+      {
+        PyErr_SetString(PyExc_TypeError, "dictionary required for argument 2.");
+        return NULL;
+      }
+      self->impl->reportSuccess( string_map_from_dictionary( dict ) );
+
+      NONE;
+    }
+
+    static PyObject* next(obj* self, PyObject* args)
+    {
+      self->impl->next();
+      NONE;
+    }
+
+    ampspy::ampspy_type_object defaultserverchooser_type;
+
+    void add_types(PyObject* module_)
+    {
+      defaultserverchooser_type.setName("AMPS.DefaultServerChooser")
+      .setBasicSize(sizeof(obj))
+      .setDestructorFunction(dtor)
+      .setConstructorFunction(ctor)
+      .setBaseType()
+      .setDoc(serverchooser_class_doc)
+      .notCopyable()
+      .addMethod("add", add, "add(uri)\n\nAdds a URI to this server chooser.\n\n:param uri: The URI of an AMPS instance that may be chosen.\n:type uri: str")
+      .addMethod("add_all", add_all, "add_all(uris)\n\nAdds a list of URIs to this server chooser.\n\n:param uris: The list of URIs of AMPS instances that may be chosen.\n:type uri: list")
+      .addMethod("get_current_uri", get_current_uri,
+                 "get_current_uri()\n\nCalled by the :class:`HAClient` to retrieve the current URI to connect to.\n\n:returns: A URI to connect to, or None if no server should be connected to.")
+      .addMethod("get_current_authenticator", get_current_authenticator,
+                 "get_current_authenticator()\n\nCalled by :class:`HAClient` to retrieve an :class:`Authenticator` to use for authentication with the current server.\n\n:returns: The current :class:`Authenticator`.")
+      .addMethod("report_failure", report_failure,
+                 "report_failure(exception, connectionInfo)\n\nInvoked by :class:`HAClient` to indicate a connection failure occurred.\n\n:param exception: An exception object containing an error message.\n:type exception: :class:`Exception`\n:param connectionInfo: A dictionary of properties associated with the failed connection.\n:type connectionInfo: dict(str, str)\n")
+      .addMethod("get_error", get_error,
+                 "get_error()\n\nProvides additional detail to be included in an exception thrown by when the AMPS instance(s) are not available. Called by the :class:`HAClient` when creating an exception.\n\n:returns: A string with information about the connection that failed and the reason for the failure. When no further information is available, returns an empty string.")
+      .addMethod("report_success", report_success,
+                 "report_success(connectionInfo)\n\nInvoked by :class:`HAClient` to indicate a connection attempt was successful.\n\n:param connectionInfo: A dictionary of properties associated with the successful connection.\n:type connectionInfo: dict(str, str)\n")
+      .addMethod("next", next, "next()\n\nInvoked to advance to the next server.")
+      .createType()
+      .registerType("DefaultServerChooser", module_);
+    }
+
+  } // namespace serverchooser
+
+} // namespace ampspy

amps-python-client-5.3.4.2/src/serverchooser_docs.h

@@ -0,0 +1,41 @@
+////////////////////////////////////////////////////////////////////////////
+//
+// Copyright (c) 2010-2024 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..
+//
+////////////////////////////////////////////////////////////////////////////
+
+static const char* serverchooser_class_doc = R"docstring(
+A simple ServerChooser that keeps a list of AMPS instances and
+Authenticators, and advances to the next one when failure occurs.
+
+To use the ``DefaultServerChooser``, you add the URIs for the server to
+choose from, then set the server for the HAClient as shown below::
+
+        client = AMPS.HAClient("showchooser")
+        chooser = AMPS.DefaultServerChooser()
+        chooser.add("tcp://server:9005/nvfix")
+        chooser.add("tcp://server-two:9005/nvfix")
+        client.set_server_chooser(chooser)
+        client.connect_and_logon()
+
+  You can add any number of URIs to the DefaultServerChooser.
+  )docstring";