amps-python-client 5.3.4.2__zip → 5.3.4.3__zip

{amps-python-client-5.3.4.2 → amps-python-client-5.3.4.3}/src/haclient_docs.h

@@ -23,10 +23,24 @@
 //
 ////////////////////////////////////////////////////////////////////////////
 
-static const char* class_doc = R"docstring(
-AMPS HAClient Object used for highly-available client connections. Derives from :class:`Client`.
+static const char* class_doc = R"docstring(HAClient(name, publish_store=None, bookmark_store=None, no_store=False)
+AMPS ``HAClient`` Object used for highly-available client connections. Derives from :class:`Client`.
 
-Constructor arguments:
+An example of a Python client publishing a JSON message using the ``HAClient`` is listed below::
+
+    client = AMPS.HAClient("test_client")
+
+    chooser = AMPS.DefaultServerChooser()
+    chooser.add("tcp://127.0.0.1:9004/amps/json")
+    client.set_server_chooser(chooser)
+
+    try:
+      client.connect_and_logon()
+      client.publish("topic_name",'{"a":1,"b":"2"}')
+    finally:
+      client.close()
+
+**Constructor Arguments:**
 
 :param name: The unique name for this client. AMPS does not enforce
              specific restrictions on the character set used, however some protocols
@@ -40,14 +54,14 @@ Constructor arguments:
 
 
 static const char* connect_and_logon_doc = R"docstring(
-Connects and logs on using the ServerChooser you've supplied via :meth:`set_server_chooser`. Will continue
+Connects and logs on using the ``ServerChooser`` you've supplied via :meth:`set_server_chooser`. Will continue
 attempting to connect and logon to each URI returned by the ``ServerChooser`` until the connection succeeds or
 the ``ServerChooser`` returns an empty URI.
 )docstring";
 
 
 static const char* haclient_connect_doc = R"docstring(
-Not used in the HAClient; call :meth:`connect_and_logon` to connect and log on to AMPS once a server chooser is set.
+Not used in the ``HAClient``; call :meth:`connect_and_logon` to connect and log on to AMPS once a server chooser is set.
 )docstring";
 
 
@@ -91,7 +105,7 @@ Gets self's server chooser and returns it.
 static const char* set_logon_options_doc = R"docstring(set_logon_options(options)
 Sets a logon options on self.
 
-:param options: An options string to be passed to the server during logon, such as ``ack_conflation=100us``.
+:param options: An options string to be passed to the server during logon, such as ``ack_conflation=100ms``.
 :type options: string
 )docstring";
 
@@ -105,34 +119,34 @@ static const char* set_timeout_doc = R"docstring(set_timeout(timeout)
 Sets the timeout, in milliseconds, used when sending a logon command to the server.
 Default value is 10000 (10 seconds).
 
-:param timeout: The number of milliseconds to wait for a server response to logon. 0 indicates no timeout.
+:param timeout: The number of milliseconds to wait for a server response to logon. ``0`` indicates no timeout.
 )docstring";
 
 
-static const char* set_reconnect_delay_doc = R"docstring(set_reconnect_delay(reconnectDelay)
+static const char* set_reconnect_delay_doc = R"docstring(set_reconnect_delay(reconnect_delay)
 Sets the delay in milliseconds used when reconnecting, after a disconnect occurs. Calling this method
-creates and installs a new FixedDelayStrategy in this client.
+creates and installs a new :class:`FixedDelayStrategy` in this client.
 Default value is 200 (0.2 seconds).
 
-:param reconnectDelay: The number of milliseconds to wait before reconnecting, after a disconnect occurs.
+:param reconnect_delay: The number of milliseconds to wait before reconnecting, after a disconnect occurs.
 )docstring";
 
 
-static const char* set_reconnect_delay_strategy_doc = R"docstring(set_reconnect_delay_strategy(reconnectDelayStrategy)
+static const char* set_reconnect_delay_strategy_doc = R"docstring(set_reconnect_delay_strategy(reconnect_delay_strategy)
 Sets the reconnect delay strategy object used to control delay behavior
 when connecting and reconnecting to servers.
 
-:param strategy: The reconnect delay strategy object to use when connecting
-                 and reconnecting to AMPS instances. The object must have
-                 the following two methods defined:
+:param reconnect_delay_strategy: The reconnect delay strategy object to use when connecting
+                                 and reconnecting to AMPS instances. The object must have
+                                 the following two methods defined:
 
-                  get_connect_wait_duration(uri):
-                    *uri* - A string containing the next URI AMPS will connect with.
-                    *Returns* an integer representing the time in milliseconds to wait
-                    before connecting to that URI.
+                                    ``get_connect_wait_duration(uri)``:
+                                      *uri* - A string containing the next URI AMPS will connect with.
+                                      *Returns* an integer representing the time in milliseconds to wait
+                                      before connecting to that URI.
 
-                  reset():
-                    Resets the state of self after a successful connection.
+                                    ``reset()``:
+                                      Resets the state of self after a successful connection.
 )docstring";
 
 

{amps-python-client-5.3.4.2 → amps-python-client-5.3.4.3}/src/nvfixbuilder.cpp

@@ -140,11 +140,11 @@ namespace ampspy
       .setDoc(nvfixbuilder_class_doc)
       .notCopyable()
       .addMethod("append", append,
-                 "append(tag,value,(optional)offset,(optional)length)\n\nAppends tag=value to self.\n\n"
+                 "append(tag,value,offset(optional),length(optional))\n\nAppends ``tag=value`` to self.\n\n"
                  ":param tag: The tag to use.\n:type tag: str\n"
                  ":param value: The value for the given tag.\n:type value: str\n"
-                 ":param offset: Optional. The offset into value at which the value actually starts.\n:type offset: int\n"
-                 ":param length: Optional. The length of the actual value within value. Only valid and required if offset is also provided.\n:type tag: int\n")
+                 ":param offset: The offset into value at which the value actually starts. *Optional.*\n:type offset: int\n"
+                 ":param length: The length of the actual value within value. *Optional.* Only valid and required if offset is also provided.\n:type length: int\n")
       .addMethod("get_string", get_string,
                  "get_string()\n\n"
                  "Called to get the string NVFIX message.\n\n"

{amps-python-client-5.3.4.2 → amps-python-client-5.3.4.3}/src/nvfixbuilder_docs.h

@@ -23,12 +23,12 @@
 //
 ////////////////////////////////////////////////////////////////////////////
 
-static const char* nvfixbuilder_class_doc = R"docstring(
+static const char* nvfixbuilder_class_doc = R"docstring(NVFIXBuilder(delimiter)
 Convenience class for easily creating NVFIX strings.
 
-Constructor arguments:
+**Constructor Arguments:**
 
-:param delimiter: The delimiter to use between NVFIX fields. Defaults to \\\\x01 if no delimiter is provided.
+:param delimiter: The delimiter to use between NVFIX fields. Defaults to \\x01 if no delimiter is provided.
 )docstring";
 
 

{amps-python-client-5.3.4.2 → amps-python-client-5.3.4.3}/src/nvfixshredder_docs.h

@@ -23,12 +23,12 @@
 //
 ////////////////////////////////////////////////////////////////////////////
 
-static const char* nvfixshredder_class_doc = R"docstring(
+static const char* nvfixshredder_class_doc = R"docstring(NVFIXShredder(delimiter)
 Convenience class for easily processing NVFIX strings.
 
-Constructor arguments:
+**Constructor Arguments:**
 
-:param separator: The delimiter to expect between NVFIX fields. Defaults to \\\\x01 if no delimiter is provided.
+:param delimiter: The delimiter to expect between NVFIX fields. Defaults to \\x01 if no delimiter is provided.
 )docstring";
 
 

{amps-python-client-5.3.4.2 → amps-python-client-5.3.4.3}/src/serverchooser_docs.h

@@ -24,11 +24,11 @@
 ////////////////////////////////////////////////////////////////////////////
 
 static const char* serverchooser_class_doc = R"docstring(
-A simple ServerChooser that keeps a list of AMPS instances and
+A simple server chooser 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::
+choose from, then set the server for the ``HAClient`` as shown below::
 
         client = AMPS.HAClient("showchooser")
         chooser = AMPS.DefaultServerChooser()
@@ -37,5 +37,5 @@ choose from, then set the server for the HAClient as shown below::
         client.set_server_chooser(chooser)
         client.connect_and_logon()
 
-  You can add any number of URIs to the DefaultServerChooser.
-  )docstring";
+You can add any number of URIs to the ``DefaultServerChooser``.
+)docstring";