PyPI - amps-python-client - Versions diffs - 5.3.4.2__zip → 5.3.4.4__zip - Mend

amps-python-client 5.3.4.2zip → 5.3.4.4zip

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (518) hide show

{amps-python-client-5.3.4.2 → amps-python-client-5.3.4.4}/docs/html/code.html RENAMED Viewed

@@ -6,7 +6,7 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>AMPS Module Reference &#8212; AMPS Python Client 5.3.4.2 documentation</title>
+    <title>AMPS Module Reference &#8212; AMPS Python Client 5.3.4.4 documentation</title>
     <link rel="stylesheet" href="_static/classic.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
@@ -14,7 +14,7 @@
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    './',
-        VERSION:     '5.3.4.2',
+        VERSION:     '5.3.4.4',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true,
@@ -41,7 +41,7 @@
         <li class="right" >
           <a href="index.html" title="AMPS Python Client Reference"
              accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">AMPS Python Client 5.3.4.2 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">AMPS Python Client 5.3.4.4 documentation</a> &#187;</li>
       </ul>
     </div>
@@ -153,32 +153,41 @@ a function of a different signature than that shown, results in undefined behavi
 <dl class="class">
 <dt id="AMPS.Client">
-<em class="property">class </em><code class="descclassname">AMPS.</code><code class="descname">Client</code><a class="headerlink" href="#AMPS.Client" title="Permalink to this definition">¶</a></dt>
+<em class="property">class </em><code class="descclassname">AMPS.</code><code class="descname">Client</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client" title="Permalink to this definition">¶</a></dt>
 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
-<blockquote>
-<div><p>The base AMPS Client object used in AMPS applications. Each Client object manages a single connection to AMPS. Each AMPS connection has a name, a specific transport (such as tcp), a protocol (used for framing messages to AMPS), and a message type (such as FIX or JSON).</p>
-<p>The Client object creates and manages a background thread, and sends and  receives messages on that thread. The object provides both a synchronous  interface for processing messages on the calling thread, and an  asynchronous interface suitable for populating a queue to be processed by worker threads.</p>
-<p>Each Client has a name. The AMPS server uses this name for duplicate message detection, so the name of each instance of the client application should be unique.</p>
-<blockquote>
-<div><p>An example of a simple Python client publishing a JSON message is listed below:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">c</span> <span class="o">=</span> <span class="n">Client</span><span class="p">(</span><span class="s2">&quot;test_client&quot;</span><span class="p">)</span>
+<p>The base AMPS Client object used in AMPS applications. Each Client
+object manages a single connection to AMPS. Each AMPS connection has
+a name, a specific transport (such as tcp), a protocol (used for framing
+messages to AMPS), and a message type (such as FIX or JSON).</p>
+<p>The Client object creates and manages a background thread, and sends and
+receives messages on that thread. The object provides both a synchronous
+interface for processing messages on the calling thread, and an
+asynchronous interface suitable for populating a queue to be processed by
+worker threads.</p>
+<p>Each Client has a name. The AMPS server uses this name for duplicate
+message detection, so the name of each instance of the client application
+should be unique.</p>
+<p>An example of a Python client publishing a JSON message is listed below:</p>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">client</span> <span class="o">=</span> <span class="n">AMPS</span><span class="o">.</span><span class="n">Client</span><span class="p">(</span><span class="s2">&quot;test_client&quot;</span><span class="p">)</span>
 <span class="k">try</span><span class="p">:</span>
-    <span class="n">c</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="s2">&quot;tcp://127.0.0.1:9004/json&quot;</span><span class="p">)</span>
-    <span class="n">cid</span> <span class="o">=</span> <span class="n">c</span><span class="o">.</span><span class="n">logon</span><span class="p">()</span>
-    <span class="n">c</span><span class="o">.</span><span class="n">publish</span><span class="p">(</span><span class="s2">&quot;topic_name&quot;</span><span class="p">,</span><span class="s1">&#39;{&quot;a&quot;:1,&quot;b&quot;:&quot;2&quot;}&#39;</span><span class="p">)</span>
+  <span class="n">client</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="s2">&quot;tcp://127.0.0.1:9004/amps/json&quot;</span><span class="p">)</span>
+  <span class="n">client</span><span class="o">.</span><span class="n">logon</span><span class="p">()</span>
+  <span class="n">client</span><span class="o">.</span><span class="n">publish</span><span class="p">(</span><span class="s2">&quot;topic_name&quot;</span><span class="p">,</span><span class="s1">&#39;{&quot;a&quot;:1,&quot;b&quot;:&quot;2&quot;}&#39;</span><span class="p">)</span>
 <span class="k">finally</span><span class="p">:</span>
-    <span class="n">c</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
+  <span class="n">client</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
 </pre></div>
 </div>
-</div></blockquote>
-</div></blockquote>
-<p>Constructor arguments:</p>
+<p><strong>Constructor Arguments:</strong></p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; the unique name for this client. AMPS does not enforce  specific restrictions on the character set used, however some protocols (for example, XML) may not allow specific characters. 60East recommends that the client name be meaningful, short, human readable, and avoid using control characters, newline characters, or square brackets.</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; The unique name for this client. AMPS does not enforce
+specific restrictions on the character set used, however some protocols
+(for example, XML) may not allow specific characters. 60East recommends
+that the client name be meaningful, short, human readable, and avoid
+using control characters, newline characters, or square brackets.</td>
 </tr>
 </tbody>
 </table>
@@ -189,12 +198,14 @@ a function of a different signature than that shown, results in undefined behavi
 <p>This class provides special values for bookmark subscriptions:</p>
 <blockquote>
 <div><ul class="simple">
-<li><code class="docutils literal"><span class="pre">EPOCH</span></code> begin the subscription at the beginning of the journal</li>
-<li><code class="docutils literal"><span class="pre">MOST_RECENT</span></code> begin the subscription at the first undiscarded message in the bookmark store, or at the end of the bookmark store if all messages have been discarded</li>
-<li><code class="docutils literal"><span class="pre">NOW</span></code> begin the subscription at the time that AMPS processes the subscription</li>
+<li><code class="docutils literal"><span class="pre">EPOCH</span></code> - Begin the subscription at the beginning of the journal.</li>
+<li><code class="docutils literal"><span class="pre">MOST_RECENT</span></code> - Begin the subscription at the first undiscarded message in the bookmark store, or at the end of the bookmark store if all messages have been discarded.</li>
+<li><code class="docutils literal"><span class="pre">NOW</span></code> - Begin the subscription at the time that AMPS processes the subscription.</li>
 </ul>
 </div></blockquote>
-<p>For example, to begin a bookmark subscription at the beginning of the journal, provide <code class="docutils literal"><span class="pre">AMPS.Client.Bookmarks.EPOCH</span></code> as the bookmark in the call to  <a class="reference internal" href="#AMPS.Client.bookmark_subscribe" title="AMPS.Client.bookmark_subscribe"><code class="xref py py-meth docutils literal"><span class="pre">AMPS.Client.bookmark_subscribe()</span></code></a>.</p>
+<p>For example, to begin a bookmark subscription at the beginning of the journal,
+provide <code class="docutils literal"><span class="pre">AMPS.Client.Bookmarks.EPOCH</span></code> as the bookmark in the call to
+<a class="reference internal" href="#AMPS.Client.bookmark_subscribe" title="AMPS.Client.bookmark_subscribe"><code class="xref py py-meth docutils literal"><span class="pre">AMPS.Client.bookmark_subscribe()</span></code></a>.</p>
 </dd></dl>
 <dl class="class">
@@ -207,11 +218,21 @@ a function of a different signature than that shown, results in undefined behavi
 <dl class="method">
 <dt id="AMPS.Client.ack">
 <code class="descclassname">Client.</code><code class="descname">ack</code><span class="sig-paren">(</span><em>message</em>, <em>options=None) OR ack(topic</em>, <em>bookmark</em>, <em>options=None</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.ack" title="Permalink to this definition">¶</a></dt>
-<dd><p>ACKs a message queue message.</p>
-<p>:param message an AMPS.Message object to ack, OR
-:param topic The topic of the message to ACK
-:param bookmark The bookmark of the message to ACK.
-:param options An optional string to include in the ACK such as &#8216;cancel&#8217;.</p>
+<dd><p>Acknowledges a message queue message.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>message</strong> &#8211; An <code class="docutils literal"><span class="pre">AMPS.Message</span></code> object to ack, OR</li>
+<li><strong>topic</strong> &#8211; The topic of the message to ack.</li>
+<li><strong>bookmark</strong> &#8211; The bookmark of the message to ack.</li>
+<li><strong>options</strong> &#8211; An optional string to include in the ack such as &#8216;cancel&#8217;.</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
 </dd></dl>
 <dl class="method">
@@ -222,7 +243,10 @@ a function of a different signature than that shown, results in undefined behavi
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>listener_callable</strong> (<em>A python function</em><em> or </em><em>other callable that takes a single value</em>) &#8211; The function or callable to be called. This function will be passed True if a connection is established, False if a disconnect occurs. Notice that when a connection is established, the client has not yet logged in or completed any recovery steps. The application should not issue commands on the client until recovery is completed.</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>listener_callable</strong> (<em>A python function</em><em> or </em><em>other callable that takes a single value.</em>) &#8211; The function or callable to be called. This function will be passed True if a
+connection is established, False if a disconnect occurs. Notice that when a connection
+is established, the client has not yet logged in or completed any recovery steps.
+The application should not issue commands on the client until recovery is completed.</td>
 </tr>
 </tbody>
 </table>
@@ -231,19 +255,18 @@ a function of a different signature than that shown, results in undefined behavi
 <dl class="method">
 <dt id="AMPS.Client.add_message_handler">
 <code class="descclassname">Client.</code><code class="descname">add_message_handler</code><span class="sig-paren">(</span><em>command_id</em>, <em>message_handler</em>, <em>acks</em>, <em>is_subscribe</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.add_message_handler" title="Permalink to this definition">¶</a></dt>
-<dd><blockquote>
-<div>Add a message handler to the <a class="reference internal" href="#AMPS.Client" title="AMPS.Client"><code class="xref py py-class docutils literal"><span class="pre">Client</span></code></a> to handle messages and the
-requested acks sent in response to the given command_id.</div></blockquote>
+<dd><p>Add a message handler to the <a class="reference internal" href="#AMPS.Client" title="AMPS.Client"><code class="xref py py-class docutils literal"><span class="pre">Client</span></code></a> to handle messages and the
+requested acknowledgments sent in response to the given <code class="docutils literal"><span class="pre">command_id</span></code>.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
-<li><strong>command_id</strong> (<em>str</em>) &#8211; The command, query, or sub id for messages and acks.</li>
+<li><strong>command_id</strong> (<em>str</em>) &#8211; The command, query, or sub ID for messages and acks.</li>
 <li><strong>message_handler</strong> (<code class="xref py py-class docutils literal"><span class="pre">MessageHandler</span></code>) &#8211; The message handler that will receive messages
-for the command_id.</li>
-<li><strong>acks</strong> (<em>int</em>) &#8211; The acks requested to go to the message_handler.</li>
-<li><strong>is_subscribe</strong> (<em>int</em>) &#8211; If the message_handler is for a subscribe command.</li>
+for the <code class="docutils literal"><span class="pre">command_id</span></code>.</li>
+<li><strong>acks</strong> (<em>str</em>) &#8211; The acknowledgments requested to go to the <code class="docutils literal"><span class="pre">message_handler</span></code>.</li>
+<li><strong>is_subscribe</strong> (<em>int</em>) &#8211; If the <code class="docutils literal"><span class="pre">message_handler</span></code> is for a subscribe command.</li>
 </ul>
 </td>
 </tr>
@@ -260,11 +283,8 @@ for the command_id.</li>
 <dl class="method">
 <dt id="AMPS.Client.allocate_message">
 <code class="descclassname">Client.</code><code class="descname">allocate_message</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.allocate_message" title="Permalink to this definition">¶</a></dt>
-<dd><blockquote>
-<div><p>Creates a new <a class="reference internal" href="#AMPS.Message" title="AMPS.Message"><code class="xref py py-class docutils literal"><span class="pre">Message</span></code></a> appropriate for this client.</p>
-<blockquote>
-<div>This function should be called rarely, since it does allocate a handful        of small objects.</div></blockquote>
-</div></blockquote>
+<dd><p>Creates a new <a class="reference internal" href="#AMPS.Message" title="AMPS.Message"><code class="xref py py-class docutils literal"><span class="pre">Message</span></code></a> appropriate for this client.</p>
+<p>This function should be called rarely, since it does allocate a handful of small objects.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
@@ -277,31 +297,43 @@ for the command_id.</li>
 <dl class="method">
 <dt id="AMPS.Client.bookmark_subscribe">
-<code class="descclassname">Client.</code><code class="descname">bookmark_subscribe</code><span class="sig-paren">(</span><em>on_message</em>, <em>topic</em>, <em>bookmark</em>, <em>filter=None</em>, <em>sub_id=None</em>, <em>options=None</em>, <em>timeout=0</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.bookmark_subscribe" title="Permalink to this definition">¶</a></dt>
-<dd><blockquote>
-<div><dl class="docutils">
-<dt>Places a bookmark subscription with AMPS. Starts replay at the most</dt>
-<dd>recent message reported by the <cite>bookmark</cite> parameter.</dd>
-</dl>
-</div></blockquote>
+<code class="descclassname">Client.</code><code class="descname">bookmark_subscribe</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.bookmark_subscribe" title="Permalink to this definition">¶</a></dt>
+<dd><p><strong>Signatures</strong>:</p>
+<ul>
+<li><p class="first"><code class="docutils literal"><span class="pre">Client.bookmark_subscribe(on_message,</span> <span class="pre">topic,</span> <span class="pre">bookmark,</span> <span class="pre">filter=None,</span> <span class="pre">sub_id=None,</span> <span class="pre">options=None,</span> <span class="pre">timeout=0)</span></code></p>
+</li>
+<li><p class="first"><code class="docutils literal"><span class="pre">Client.bookmark_subscribe(topic,</span> <span class="pre">bookmark,</span> <span class="pre">filter=None,</span> <span class="pre">sub_id=None,</span> <span class="pre">options=None,</span> <span class="pre">timeout=0)</span></code></p>
+<p>Places a bookmark subscription with AMPS. Starts replay at the most recent message reported by the <code class="docutils literal"><span class="pre">bookmark</span></code> parameter.</p>
+<p>There are two ways to use this method:</p>
+<ol class="arabic simple">
+<li>When a message handler is provided, this method submits the <code class="docutils literal"><span class="pre">bookmark_subscribe</span></code> command on a background
+thread and calls the message handler with individual messages from the transaction log replay (if any) and
+then cuts over to live messages that match the subscription.</li>
+<li>When no message handler is provided, this method returns a message stream that can be iterated on to process
+messages received from the transaction log replay (if any) and then cuts over to live messages that match
+the subscription.</li>
+</ol>
+</li>
+</ul>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
-<li><strong>on_message</strong> (<code class="xref py py-class docutils literal"><span class="pre">MessageHandler</span></code>) &#8211; The message handler to invoke with matching messages.</li>
-<li><strong>topic</strong> (<em>str</em>) &#8211; The <cite>Topic</cite> to subscribe to.</li>
-<li><strong>bookmark</strong> (<em>str</em>) &#8211; A bookmark identifier, or one of the constants from
-<a class="reference internal" href="#AMPS.Client.Bookmarks" title="AMPS.Client.Bookmarks"><code class="xref py py-class docutils literal"><span class="pre">Bookmarks</span></code></a></li>
+<li><strong>on_message</strong> (<code class="xref py py-class docutils literal"><span class="pre">MessageHandler</span></code>) &#8211; The message handler to invoke with matching messages
+(specified only in the case where async processing is used).</li>
+<li><strong>topic</strong> (<em>str</em>) &#8211; The topic to subscribe to.</li>
+<li><strong>bookmark</strong> (<em>str</em>) &#8211; A bookmark identifier or one of the constants from
+<a class="reference internal" href="#AMPS.Client.Bookmarks" title="AMPS.Client.Bookmarks"><code class="xref py py-class docutils literal"><span class="pre">Bookmarks</span></code></a>.</li>
 <li><strong>filter</strong> (<em>str</em>) &#8211; The filter.</li>
-<li><strong>sub_id</strong> (<em>str</em>) &#8211; The subscription ID.  You may optionally provide a
+<li><strong>sub_id</strong> (<em>str</em>) &#8211; The subscription ID. You may optionally provide a
 subscription ID to ease recovery scenarios, instead of having the
 system automatically generate one for you.
 When used with the &#8216;replace&#8217; option, this is the subscription to
 be replaced.
 With a bookmark store, this is the subscription ID used for
 recovery. So, when using a persistent bookmark store, provide an explicit
-subscription id that is consistent across application restarts.</li>
+subscription ID that is consistent across application restarts.</li>
 <li><strong>options</strong> (<em>str</em>) &#8211; A comma separated string of options. Default is <cite>None</cite>.</li>
 <li><strong>timeout</strong> (<em>int</em>) &#8211; The maximum time to wait for the client to receive and
 and consume a processed ack for this subscription
@@ -309,7 +341,12 @@ and consume a processed ack for this subscription
 </ul>
 </td>
 </tr>
-<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last"><a class="reference internal" href="#AMPS.SubscriptionAlreadyExistsException" title="AMPS.SubscriptionAlreadyExistsException"><code class="xref py py-exc docutils literal"><span class="pre">SubscriptionAlreadyExistsException</span></code></a>,
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The command identifier assigned to this command if a message handler was provided.
+If no message handler was provided, returns a <code class="docutils literal"><span class="pre">MessageStream</span></code> containing the
+results of the command.</p>
+</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last"><a class="reference internal" href="#AMPS.SubscriptionAlreadyExistsException" title="AMPS.SubscriptionAlreadyExistsException"><code class="xref py py-exc docutils literal"><span class="pre">SubscriptionAlreadyExistsException</span></code></a>,
 <a class="reference internal" href="#AMPS.BadFilterException" title="AMPS.BadFilterException"><code class="xref py py-exc docutils literal"><span class="pre">BadFilterException</span></code></a>, <a class="reference internal" href="#AMPS.BadRegexTopicException" title="AMPS.BadRegexTopicException"><code class="xref py py-exc docutils literal"><span class="pre">BadRegexTopicException</span></code></a>,
 <a class="reference internal" href="#AMPS.TimedOutException" title="AMPS.TimedOutException"><code class="xref py py-exc docutils literal"><span class="pre">TimedOutException</span></code></a>, <a class="reference internal" href="#AMPS.DisconnectedException" title="AMPS.DisconnectedException"><code class="xref py py-exc docutils literal"><span class="pre">DisconnectedException</span></code></a>.</p>
 </td>
@@ -327,47 +364,34 @@ and consume a processed ack for this subscription
 <dl class="method">
 <dt id="AMPS.Client.connect">
 <code class="descclassname">Client.</code><code class="descname">connect</code><span class="sig-paren">(</span><em>uri</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.connect" title="Permalink to this definition">¶</a></dt>
-<dd><blockquote>
-<div><p>Connects to the AMPS instance through the provided <code class="xref py py-class docutils literal"><span class="pre">URI</span></code>.</p>
+<dd><p>Connects to the AMPS instance through the provided <code class="xref py py-class docutils literal"><span class="pre">URI</span></code>.</p>
 <blockquote>
 <div><dl class="docutils">
 <dt>The <code class="xref py py-class docutils literal"><span class="pre">URI</span></code> is a string with the format:</dt>
-<dd><code class="docutils literal"><span class="pre">transport://userId:password&#64;host:port/protocol</span></code> where:</dd>
+<dd><code class="docutils literal"><span class="pre">transport://userId:password&#64;host:port/protocol</span></code></dd>
 </dl>
+<p>The components of the <code class="xref py py-class docutils literal"><span class="pre">URI</span></code> are as follows:</p>
 <ul class="simple">
 <li><em>transport</em> &#8211; The network transport used for the connection.</li>
-<li><dl class="first docutils">
-<dt><em>userId</em> &#8211; If authentication is enabled, this is the unique user ID</dt>
-<dd>used to authenticate the connection.</dd>
-</dl>
-</li>
-<li><dl class="first docutils">
-<dt><em>password</em> &#8211; If authentication is enabled, this is the password used</dt>
-<dd>to authenticate the connection.</dd>
-</dl>
-</li>
-<li><dl class="first docutils">
-<dt><em>host</em> &#8211; The hostname or IP address of the host where AMPS is</dt>
-<dd>installed.</dd>
-</dl>
-</li>
+<li><em>userId</em> &#8211; If authentication is enabled, this is the unique user ID used to authenticate the connection.</li>
+<li><em>password</em> &#8211; If authentication is enabled, this is the password used to authenticate the connection.</li>
+<li><em>host</em> &#8211; The hostname or IP address of the host where AMPS is installed.</li>
 <li><em>port</em> &#8211; The port to connect to the AMPS instance.</li>
 <li><em>protocol</em> &#8211; The protocol used by this connection.</li>
 </ul>
 <div class="admonition note">
 <p class="first admonition-title">Note</p>
-<p class="last">Authentication is optional, if the system is using the
-default authentication with AMPS which allows all users in without
+<p class="last">Authentication is optional. If the system is using the
+default authentication with AMPS, which allows all users in without
 regard for their <code class="docutils literal"><span class="pre">userId</span></code> or <code class="docutils literal"><span class="pre">password</span></code>, then the
 <code class="docutils literal"><span class="pre">userId:password&#64;</span></code> string can be omitted from the connect URI.</p>
 </div>
 </div></blockquote>
-</div></blockquote>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>uri</strong> (<em>str</em>) &#8211; The :class`URI` used to connect to AMPS.</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>uri</strong> (<em>str</em>) &#8211; The <code class="xref py py-class docutils literal"><span class="pre">URI</span></code> used to connect to AMPS.</td>
 </tr>
 <tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><a class="reference internal" href="#AMPS.ConnectionException" title="AMPS.ConnectionException"><code class="xref py py-class docutils literal"><span class="pre">ConnectionException</span></code></a></td>
 </tr>
@@ -377,9 +401,9 @@ regard for their <code class="docutils literal"><span class="pre">userId</span><
 <dl class="method">
 <dt id="AMPS.Client.convert_version_to_number">
-<code class="descclassname">Client.</code><code class="descname">convert_version_to_number</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.convert_version_to_number" title="Permalink to this definition">¶</a></dt>
-<dd><p>convert_version_to_number(version)Converts the provided version string to a number using 2 digits for each dot.
-A value such as 4.0 will become 4000000 while 3.8.1.7 will return 3080107.</p>
+<code class="descclassname">Client.</code><code class="descname">convert_version_to_number</code><span class="sig-paren">(</span><em>version</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.convert_version_to_number" title="Permalink to this definition">¶</a></dt>
+<dd><p>Converts the provided version string to a number using 2 digits for each dot.
+A value such as 4.0.0.0 will become 4000000 while 3.8.1.7 will return 3080107.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
@@ -396,22 +420,18 @@ A value such as 4.0 will become 4000000 while 3.8.1.7 will return 3080107.</p>
 <dt id="AMPS.Client.deltaPublish">
 <code class="descclassname">Client.</code><code class="descname">deltaPublish</code><span class="sig-paren">(</span><em>topic</em>, <em>data</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.deltaPublish" title="Permalink to this definition">¶</a></dt>
 <dd><p>This is a legacy method name for <a class="reference internal" href="#AMPS.Client.delta_publish" title="AMPS.Client.delta_publish"><code class="xref py py-meth docutils literal"><span class="pre">delta_publish()</span></code></a>.</p>
-<blockquote>
-<div><div class="deprecated">
+<div class="deprecated">
 <p><span class="versionmodified">Deprecated since version 3.2.0.0: </span>Use <a class="reference internal" href="#AMPS.Client.delta_publish" title="AMPS.Client.delta_publish"><code class="xref py py-func docutils literal"><span class="pre">delta_publish()</span></code></a> instead.</p>
 </div>
-</div></blockquote>
 </dd></dl>
 <dl class="method">
 <dt id="AMPS.Client.deltaSubscribe">
 <code class="descclassname">Client.</code><code class="descname">deltaSubscribe</code><span class="sig-paren">(</span><em>on_message</em>, <em>topic</em>, <em>filter=None</em>, <em>options=0</em>, <em>timeout=0</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.deltaSubscribe" title="Permalink to this definition">¶</a></dt>
 <dd><p>A legacy method name for <a class="reference internal" href="#AMPS.Client.delta_subscribe" title="AMPS.Client.delta_subscribe"><code class="xref py py-meth docutils literal"><span class="pre">delta_subscribe()</span></code></a>.</p>
-<blockquote>
-<div><div class="deprecated">
+<div class="deprecated">
 <p><span class="versionmodified">Deprecated since version 3.2.0.0: </span>Use <a class="reference internal" href="#AMPS.Client.delta_subscribe" title="AMPS.Client.delta_subscribe"><code class="xref py py-func docutils literal"><span class="pre">delta_subscribe()</span></code></a> instead.</p>
 </div>
-</div></blockquote>
 </dd></dl>
 <dl class="method">
@@ -427,9 +447,9 @@ then the client will store before forwarding the message to AMPS.</p>
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
-<li><strong>topic</strong> (<em>str</em>) &#8211; <cite>Topic</cite> to publish the data to.</li>
-<li><strong>data</strong> (<em>str</em>) &#8211; <cite>Data</cite> to publish to the topic.</li>
-<li><strong>expiration</strong> (<em>int</em>) &#8211; Number of seconds until published message should expire.</li>
+<li><strong>topic</strong> (<em>str</em>) &#8211; The topic to publish the data to.</li>
+<li><strong>data</strong> (<em>str</em>) &#8211; The data to publish to the topic.</li>
+<li><strong>expiration</strong> (<em>int</em>) &#8211; Number of seconds until published messages should expire.</li>
 </ul>
 </td>
 </tr>
@@ -446,15 +466,30 @@ or 0 if there is no publish store and the server is assigning sequence numbers.<
 <dl class="method">
 <dt id="AMPS.Client.delta_subscribe">
-<code class="descclassname">Client.</code><code class="descname">delta_subscribe</code><span class="sig-paren">(</span><em>on_message</em>, <em>topic</em>, <em>filter=None</em>, <em>options=0</em>, <em>timeout=0</em>, <em>sub_id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.delta_subscribe" title="Permalink to this definition">¶</a></dt>
-<dd><p>Places a delta subscription with AMPS.</p>
+<code class="descclassname">Client.</code><code class="descname">delta_subscribe</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.delta_subscribe" title="Permalink to this definition">¶</a></dt>
+<dd><p><strong>Signatures</strong>:</p>
+<ul>
+<li><p class="first"><code class="docutils literal"><span class="pre">Client.delta_subscribe(on_message,</span> <span class="pre">topic,</span> <span class="pre">filter=None,</span> <span class="pre">options=None,</span> <span class="pre">timeout=0,</span> <span class="pre">sub_id=None)</span></code></p>
+</li>
+<li><p class="first"><code class="docutils literal"><span class="pre">Client.delta_subscribe(topic,</span> <span class="pre">filter=None,</span> <span class="pre">options=None,</span> <span class="pre">timeout=0,</span> <span class="pre">sub_id=None)</span></code></p>
+<p>Places a delta subscription with AMPS.</p>
+<p>There are two ways to use this method:</p>
+<ol class="arabic simple">
+<li>When a message handler is provided, this method submits the <code class="docutils literal"><span class="pre">delta_subscribe</span></code> command on a background thread
+and calls the message handler with individual messages that match the subscription and that contain the updated fields.</li>
+<li>When no message handler is provided, this method returns a message stream that can be iterated on to process
+messages received that match the subscription and that contain the updated fields.</li>
+</ol>
+</li>
+</ul>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
-<li><strong>on_message</strong> (<em>str</em>) &#8211; The message handler to invoke with matching
-messages.</li>
+<li><strong>on_message</strong> (<em>str</em>) &#8211; The message handler to invoke with matching messages
+(specified only in the case where async processing
+is used).</li>
 <li><strong>topic</strong> (<em>str</em>) &#8211; The topic to subscribe to.</li>
 <li><strong>filter</strong> (<em>str</em>) &#8211; The filter.</li>
 <li><strong>options</strong> (<em>str</em>) &#8211; A comma separated list of values indicating additional
@@ -465,12 +500,14 @@ consume the processed ack for this subscription
 <li><strong>sub_id</strong> (<em>str</em>) &#8211; The subscription ID.  You may optionally provide a
 subscription ID to ease recovery scenarios, instead of having the
 system automatically generate one for you.
-When used with the &#8216;replace&#8217; option, this is the subscription to
+When used with the <code class="docutils literal"><span class="pre">replace</span></code> option, this is the subscription to
 be replaced.</li>
 </ul>
 </td>
 </tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The command identifier assigned to this command.</p>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The command identifier assigned to this command if a message handler was provided.
+If no message handler was provided, returns a <code class="docutils literal"><span class="pre">MessageStream</span></code> containing the
+results of the command.</p>
 </td>
 </tr>
 <tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last"><a class="reference internal" href="#AMPS.SubscriptionAlreadyExistsException" title="AMPS.SubscriptionAlreadyExistsException"><code class="xref py py-exc docutils literal"><span class="pre">SubscriptionAlreadyExistsException</span></code></a>,
@@ -490,15 +527,17 @@ be replaced.</li>
 <dl class="method">
 <dt id="AMPS.Client.execute">
-<code class="descclassname">Client.</code><code class="descname">execute</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.execute" title="Permalink to this definition">¶</a></dt>
-<dd><p>Executes a Command on self.</p>
+<code class="descclassname">Client.</code><code class="descname">execute</code><span class="sig-paren">(</span><em>command</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.execute" title="Permalink to this definition">¶</a></dt>
+<dd><p>Execute the provided command and process responses using a <code class="docutils literal"><span class="pre">MessageStream</span></code>. This method creates
+a <code class="docutils literal"><span class="pre">Message</span></code> based on the provided <code class="docutils literal"><span class="pre">Command</span></code>, sends the <code class="docutils literal"><span class="pre">Message</span></code> to AMPS, and returns a
+<code class="docutils literal"><span class="pre">MessageStream</span></code> that can be iterated on to process messages returned in response to the command.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Param:</th><td class="field-body">An AMPS.Command to execute.</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>command</strong> (<a class="reference internal" href="#AMPS.Command" title="AMPS.Command"><em>AMPS.Command</em></a>) &#8211; The command to execute.</td>
 </tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">A MessageStream to iterate over.</td>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">A <code class="docutils literal"><span class="pre">MessageStream</span></code> to iterate over.</td>
 </tr>
 </tbody>
 </table>
@@ -506,17 +545,20 @@ be replaced.</li>
 <dl class="method">
 <dt id="AMPS.Client.execute_async">
-<code class="descclassname">Client.</code><code class="descname">execute_async</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.execute_async" title="Permalink to this definition">¶</a></dt>
-<dd><p>Execute the provided command and process responses on the client receive thread using the provided handler.</p>
-<p>This method creates a <code class="docutils literal"><span class="pre">Message</span></code> based on the provided <code class="docutils literal"><span class="pre">Command</span></code>, sends the  <code class="docutils literal"><span class="pre">Message</span></code> to AMPS, and invokes the provided handler to process messages returned in response to the command. Rather than providing messages on the calling thread, the AMPS Python client runs the handler directly on the client receive thread.</p>
-<p>When the provided handler is not <code class="docutils literal"><span class="pre">None</span></code>, this function blocks until AMPS acknowledges that the command has been processed. The results of the command after that acknowledgement are provided to the handler.</p>
+<code class="descclassname">Client.</code><code class="descname">execute_async</code><span class="sig-paren">(</span><em>command</em>, <em>on_message</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.execute_async" title="Permalink to this definition">¶</a></dt>
+<dd><p>Execute the provided command and process responses on the client receive thread using the provided handler.
+This method creates a <code class="docutils literal"><span class="pre">Message</span></code> based on the provided <code class="docutils literal"><span class="pre">Command</span></code>, sends the <code class="docutils literal"><span class="pre">Message</span></code> to AMPS, and
+invokes the provided handler to process messages returned in response to the command. Rather than providing
+messages on the calling thread, the AMPS Python client runs the handler directly on the client receive thread.</p>
+<p>When the provided handler is not <code class="docutils literal"><span class="pre">None</span></code>, this function blocks until AMPS acknowledges that the command has
+been processed. The results of the command after that acknowledgment are provided to the handler.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
 <li><strong>command</strong> (<a class="reference internal" href="#AMPS.Command" title="AMPS.Command"><em>AMPS.Command</em></a>) &#8211; The command to execute.</li>
-<li><strong>on_message</strong> (<em>a function</em><em> or </em><em>other callable object.</em>) &#8211; A handler for messages returned by this command execution.</li>
+<li><strong>on_message</strong> (<em>A function</em><em> or </em><em>other callable object.</em>) &#8211; A handler for messages returned by this command execution.</li>
 </ul>
 </td>
 </tr>
@@ -529,8 +571,18 @@ be replaced.</li>
 <dl class="method">
 <dt id="AMPS.Client.flush">
-<code class="descclassname">Client.</code><code class="descname">flush</code><span class="sig-paren">(</span><em>timeout = 0</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.flush" title="Permalink to this definition">¶</a></dt>
+<code class="descclassname">Client.</code><code class="descname">flush</code><span class="sig-paren">(</span><em>timeout=0</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.flush" title="Permalink to this definition">¶</a></dt>
 <dd><p>Another name for <a class="reference internal" href="#AMPS.Client.publish_flush" title="AMPS.Client.publish_flush"><code class="xref py py-meth docutils literal"><span class="pre">publish_flush()</span></code></a>.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>timeout</strong> (<em>int</em>) &#8211; The maximum time to wait for the messages to be acknowledged
+as persisted, or for the flush command to be acknowledged
+by AMPS (in milliseconds). <code class="docutils literal"><span class="pre">0</span></code> indicates to wait indefinitely.</td>
+</tr>
+</tbody>
+</table>
 </dd></dl>
 <dl class="method">
@@ -542,60 +594,112 @@ be replaced.</li>
 <dl class="method">
 <dt id="AMPS.Client.get_ack_batch_size">
 <code class="descclassname">Client.</code><code class="descname">get_ack_batch_size</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.get_ack_batch_size" title="Permalink to this definition">¶</a></dt>
-<dd><p>Returns the current batch size used for batching message queue ACK messages.</p>
+<dd><p>Gets the current batch size used for batching message queue acknowledgment messages.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The current batch size used for batching message queue ack messages.</td>
+</tr>
+</tbody>
+</table>
 </dd></dl>
 <dl class="method">
 <dt id="AMPS.Client.get_ack_timeout">
 <code class="descclassname">Client.</code><code class="descname">get_ack_timeout</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.get_ack_timeout" title="Permalink to this definition">¶</a></dt>
-<dd><p>Returns the current time (milliseconds) before queued ack messages are sent.</p>
+<dd><p>Gets the current time (milliseconds) before queued acknowledgment messages are sent.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The current time (milliseconds) before queued ack messages are sent.</td>
+</tr>
+</tbody>
+</table>
 </dd></dl>
 <dl class="method">
 <dt id="AMPS.Client.get_auto_ack">
 <code class="descclassname">Client.</code><code class="descname">get_auto_ack</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.get_auto_ack" title="Permalink to this definition">¶</a></dt>
-<dd><p>Returns True if auto-acknowledgement of message queue messages is enabled.</p>
+<dd><p>Called to check if auto-acknowledgment of message queue messages is enabled.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">True, if auto-acknowledgment of message queue messages is enabled.</td>
+</tr>
+</tbody>
+</table>
 </dd></dl>
 <dl class="method">
 <dt id="AMPS.Client.get_default_max_depth">
 <code class="descclassname">Client.</code><code class="descname">get_default_max_depth</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.get_default_max_depth" title="Permalink to this definition">¶</a></dt>
-<dd><p>:returns The current maximum depth for new MessageStreams, 0 is no maximum.</p>
+<dd><p>Gets the maximum depth for any new <code class="docutils literal"><span class="pre">MessageStream</span></code>.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The current maximum depth for any new <code class="docutils literal"><span class="pre">MessageStream</span></code>. <code class="docutils literal"><span class="pre">0</span></code> is no maximum.</td>
+</tr>
+</tbody>
+</table>
 </dd></dl>
 <dl class="method">
 <dt id="AMPS.Client.get_duplicate_message_handler">
 <code class="descclassname">Client.</code><code class="descname">get_duplicate_message_handler</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.get_duplicate_message_handler" title="Permalink to this definition">¶</a></dt>
-<dd><p>Returns the message handler object set with set_duplicate_message_handler.</p>
+<dd><p>Gets the message handler object set with <a class="reference internal" href="#AMPS.Client.set_duplicate_message_handler" title="AMPS.Client.set_duplicate_message_handler"><code class="xref py py-meth docutils literal"><span class="pre">set_duplicate_message_handler()</span></code></a>.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The message handler object set with <a class="reference internal" href="#AMPS.Client.set_duplicate_message_handler" title="AMPS.Client.set_duplicate_message_handler"><code class="xref py py-meth docutils literal"><span class="pre">set_duplicate_message_handler()</span></code></a>.</td>
+</tr>
+</tbody>
+</table>
 </dd></dl>
 <dl class="method">
 <dt id="AMPS.Client.get_error_on_publish_gap">
 <code class="descclassname">Client.</code><code class="descname">get_error_on_publish_gap</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.get_error_on_publish_gap" title="Permalink to this definition">¶</a></dt>
-<dd><blockquote>
-<div>Called to check if the Store will throw PublishStoreGapException.</div></blockquote>
-<dl class="docutils">
-<dt>:returns If true, PublishStoreGapException can be thrown</dt>
-<dd>by the client publish store if the client logs onto a server that
-appears to be missing messages no longer held in the store.</dd>
-</dl>
+<dd><p>Called to check if the Store will throw <a class="reference internal" href="#AMPS.PublishStoreGapException" title="AMPS.PublishStoreGapException"><code class="xref py py-exc docutils literal"><span class="pre">PublishStoreGapException</span></code></a>.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">If true, <a class="reference internal" href="#AMPS.PublishStoreGapException" title="AMPS.PublishStoreGapException"><code class="xref py py-exc docutils literal"><span class="pre">PublishStoreGapException</span></code></a> can be thrown
+by the client publish store if the client logs onto a server that
+appears to be missing messages no longer held in the store.</td>
+</tr>
+</tbody>
+</table>
 </dd></dl>
 <dl class="method">
 <dt id="AMPS.Client.get_exception_listener">
 <code class="descclassname">Client.</code><code class="descname">get_exception_listener</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.get_exception_listener" title="Permalink to this definition">¶</a></dt>
-<dd><p>Returns the exception listener callable set on self, or None.</p>
+<dd><p>Gets the exception listener callable set on self.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The exception listener callable set on self, or None.</td>
+</tr>
+</tbody>
+</table>
 </dd></dl>
 <dl class="method">
 <dt id="AMPS.Client.get_logon_correlation_data">
 <code class="descclassname">Client.</code><code class="descname">get_logon_correlation_data</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.get_logon_correlation_data" title="Permalink to this definition">¶</a></dt>
-<dd><p>Returns the data used to correlate the logon of this Client to the server.</p>
+<dd><p>Gets the data used to correlate the logon of this <a class="reference internal" href="#AMPS.Client" title="AMPS.Client"><code class="xref py py-class docutils literal"><span class="pre">Client</span></code></a> to the server.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">logon correlation data</td>
+<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The logon correlation data.</td>
 </tr>
 </tbody>
 </table>
@@ -604,12 +708,12 @@ appears to be missing messages no longer held in the store.</dd>
 <dl class="method">
 <dt id="AMPS.Client.get_name">
 <code class="descclassname">Client.</code><code class="descname">get_name</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.get_name" title="Permalink to this definition">¶</a></dt>
-<dd><p>Returns the name of the <cite>Client</cite> object.</p>
+<dd><p>Gets the name of the <a class="reference internal" href="#AMPS.Client" title="AMPS.Client"><code class="xref py py-class docutils literal"><span class="pre">Client</span></code></a> object.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">name</td>
+<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The <a class="reference internal" href="#AMPS.Client" title="AMPS.Client"><code class="xref py py-class docutils literal"><span class="pre">Client</span></code></a> name.</td>
 </tr>
 </tbody>
 </table>
@@ -618,12 +722,12 @@ appears to be missing messages no longer held in the store.</dd>
 <dl class="method">
 <dt id="AMPS.Client.get_name_hash">
 <code class="descclassname">Client.</code><code class="descname">get_name_hash</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.get_name_hash" title="Permalink to this definition">¶</a></dt>
-<dd><p>Returns the string name hash of the <cite>Client</cite> object.</p>
+<dd><p>Gets the string name hash of the <a class="reference internal" href="#AMPS.Client" title="AMPS.Client"><code class="xref py py-class docutils literal"><span class="pre">Client</span></code></a> object.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">name hash string</td>
+<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The name hash string.</td>
 </tr>
 </tbody>
 </table>
@@ -632,12 +736,12 @@ appears to be missing messages no longer held in the store.</dd>
 <dl class="method">
 <dt id="AMPS.Client.get_name_hash_value">
 <code class="descclassname">Client.</code><code class="descname">get_name_hash_value</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.get_name_hash_value" title="Permalink to this definition">¶</a></dt>
-<dd><p>Returns the numeric name hash of the <cite>Client</cite> object.</p>
+<dd><p>Gets the numeric name hash of the <a class="reference internal" href="#AMPS.Client" title="AMPS.Client"><code class="xref py py-class docutils literal"><span class="pre">Client</span></code></a> object.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">name hash int</td>
+<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The name hash int.</td>
 </tr>
 </tbody>
 </table>
@@ -646,18 +750,26 @@ appears to be missing messages no longer held in the store.</dd>
 <dl class="method">
 <dt id="AMPS.Client.get_retry_on_disconnect">
 <code class="descclassname">Client.</code><code class="descname">get_retry_on_disconnect</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.get_retry_on_disconnect" title="Permalink to this definition">¶</a></dt>
-<dd><p>Returns True if automatic retry of a command to AMPS after a reconnect is enabled.</p>
+<dd><p>Called to check if automatic retry of a command to AMPS after a reconnect is enabled.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">True, if automatic retry of a command to AMPS after a reconnect is enabled.</td>
+</tr>
+</tbody>
+</table>
 </dd></dl>
 <dl class="method">
 <dt id="AMPS.Client.get_server_version">
 <code class="descclassname">Client.</code><code class="descname">get_server_version</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.get_server_version" title="Permalink to this definition">¶</a></dt>
-<dd><p>Returns the connected server&#8217;s version as a numeric value.</p>
+<dd><p>Gets the connected server&#8217;s version as a numeric value.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The version converted to a number: server version 3.8.1.7 would be 3080107</td>
+<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The version converted to a number. For example, server version 3.8.1.7 would be 3080107.</td>
 </tr>
 </tbody>
 </table>
@@ -666,26 +778,32 @@ appears to be missing messages no longer held in the store.</dd>
 <dl class="method">
 <dt id="AMPS.Client.get_server_version_info">
 <code class="descclassname">Client.</code><code class="descname">get_server_version_info</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.get_server_version_info" title="Permalink to this definition">¶</a></dt>
-<dd><p>Returns the connected server&#8217;s version as a VersionInfo.</p>
+<dd><p>Gets the connected server&#8217;s version as a VersionInfo.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The version in a VersionInfo</td>
+<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The version in a VersionInfo.</td>
 </tr>
 </tbody>
 </table>
 </dd></dl>
+<dl class="method">
+<dt id="AMPS.Client.get_ssl">
+<code class="descclassname">Client.</code><code class="descname">get_ssl</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.get_ssl" title="Permalink to this definition">¶</a></dt>
+<dd><p>For a tcps client, returns the PySSLSocket of the connection</p>
+</dd></dl>
 <dl class="method">
 <dt id="AMPS.Client.get_unpersisted_count">
 <code class="descclassname">Client.</code><code class="descname">get_unpersisted_count</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.get_unpersisted_count" title="Permalink to this definition">¶</a></dt>
-<dd><p>Returns the count of unpersisted publishes.</p>
+<dd><p>Gets the count of unpersisted publishes.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">count of unpersisted publishes.</td>
+<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The count of unpersisted publishes.</td>
 </tr>
 </tbody>
 </table>
@@ -694,13 +812,12 @@ appears to be missing messages no longer held in the store.</dd>
 <dl class="method">
 <dt id="AMPS.Client.get_uri">
 <code class="descclassname">Client.</code><code class="descname">get_uri</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.get_uri" title="Permalink to this definition">¶</a></dt>
-<dd><p>Returns the <code class="xref py py-class docutils literal"><span class="pre">URI</span></code> string passed into the <a class="reference internal" href="#AMPS.Client" title="AMPS.Client"><code class="xref py py-class docutils literal"><span class="pre">Client</span></code></a>
-during the <a class="reference internal" href="#AMPS.Client.connect" title="AMPS.Client.connect"><code class="xref py py-meth docutils literal"><span class="pre">connect()</span></code></a> invocation.</p>
+<dd><p>Gets the <code class="xref py py-class docutils literal"><span class="pre">URI</span></code> string passed into the <a class="reference internal" href="#AMPS.Client" title="AMPS.Client"><code class="xref py py-class docutils literal"><span class="pre">Client</span></code></a> during the <a class="reference internal" href="#AMPS.Client.connect" title="AMPS.Client.connect"><code class="xref py py-meth docutils literal"><span class="pre">connect()</span></code></a> invocation.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">uri</td>
+<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The URI string.</td>
 </tr>
 </tbody>
 </table>
@@ -708,7 +825,7 @@ during the <a class="reference internal" href="#AMPS.Client.connect" title="AMPS
 <dl class="method">
 <dt id="AMPS.Client.logon">
-<code class="descclassname">Client.</code><code class="descname">logon</code><span class="sig-paren">(</span><em>timeout=0</em>, <em>authenticator=AMPS.DefaultAuthenticator</em>, <em>options=''</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.logon" title="Permalink to this definition">¶</a></dt>
+<code class="descclassname">Client.</code><code class="descname">logon</code><span class="sig-paren">(</span><em>timeout=0</em>, <em>authenticator=AMPS.DefaultAuthenticator</em>, <em>options=None</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.logon" title="Permalink to this definition">¶</a></dt>
 <dd><p>Logs into AMPS with the parameters provided in the <a class="reference internal" href="#AMPS.Client.connect" title="AMPS.Client.connect"><code class="xref py py-meth docutils literal"><span class="pre">connect()</span></code></a> method.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
@@ -717,10 +834,9 @@ during the <a class="reference internal" href="#AMPS.Client.connect" title="AMPS
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
 <li><strong>timeout</strong> (<em>int</em>) &#8211; The maximum time to wait for the command to
 receive a processed ack from AMPS for the logon command
-(in milliseconds). <code class="docutils literal"><span class="pre">0`</span></code> indicates to wait indefinitely.</li>
+(in milliseconds). <code class="docutils literal"><span class="pre">0</span></code> indicates to wait indefinitely.</li>
 <li><strong>authenticator</strong> (<em>Authenticator</em>) &#8211; An <cite>Authenticator</cite> object used to negotiate logon.</li>
-<li><strong>options</strong> (<em>string</em>) &#8211; An options string to pass to the server such as ack_conflation=10ms
-execute (milliseconds). <code class="docutils literal"><span class="pre">0</span></code> indicates to wait indefinitely.</li>
+<li><strong>options</strong> (<em>string</em>) &#8211; An options string to be passed to the server during logon, such as <code class="docutils literal"><span class="pre">ack_conflation=100ms</span></code>.</li>
 </ul>
 </td>
 </tr>
@@ -737,12 +853,12 @@ execute (milliseconds). <code class="docutils literal"><span class="pre">0</span
 <dl class="method">
 <dt id="AMPS.Client.name">
 <code class="descclassname">Client.</code><code class="descname">name</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.name" title="Permalink to this definition">¶</a></dt>
-<dd><p>Returns the name of the <cite>Client</cite> object.</p>
+<dd><p>The name of the <a class="reference internal" href="#AMPS.Client" title="AMPS.Client"><code class="xref py py-class docutils literal"><span class="pre">Client</span></code></a> object.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">name</td>
+<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The <a class="reference internal" href="#AMPS.Client" title="AMPS.Client"><code class="xref py py-class docutils literal"><span class="pre">Client</span></code></a> name.</td>
 </tr>
 </tbody>
 </table>
@@ -751,13 +867,10 @@ execute (milliseconds). <code class="docutils literal"><span class="pre">0</span
 <dl class="method">
 <dt id="AMPS.Client.publish">
 <code class="descclassname">Client.</code><code class="descname">publish</code><span class="sig-paren">(</span><em>topic</em>, <em>data</em>, <em>expiration=None</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.publish" title="Permalink to this definition">¶</a></dt>
-<dd><p>Publish a mesage to an AMPS topic.
-This method does not wait for a response from the AMPS server.
-To detect failure, install a failed write handler.
-If the client was created with a persistent store on construction,
-then the client will store before forwarding the message to AMPS.
-If a DisconnectException occurs, the message
-is still stored in the publish store.</p>
+<dd><p>Publish a message to an AMPS topic. This method does not wait for a response from the AMPS server.
+To detect failure, install a failed write handler. If the client was created with a persistent store
+on construction, then the client will store before forwarding the message to AMPS. If a <code class="docutils literal"><span class="pre">DisconnectException</span></code>
+occurs, the message is still stored in the publish store.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
@@ -773,7 +886,7 @@ is still stored in the publish store.</p>
 or 0 if there is no publish store and the server is assigning sequence numbers.</p>
 </td>
 </tr>
-<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last"><a class="reference internal" href="#AMPS.DisconnectedException" title="AMPS.DisconnectedException"><code class="xref py py-exc docutils literal"><span class="pre">DisconnectedException</span></code></a> The client is not connected; the program needs to call connect()</p>
+<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last"><a class="reference internal" href="#AMPS.DisconnectedException" title="AMPS.DisconnectedException"><code class="xref py py-exc docutils literal"><span class="pre">DisconnectedException</span></code></a></p>
 </td>
 </tr>
 </tbody>
@@ -782,9 +895,19 @@ or 0 if there is no publish store and the server is assigning sequence numbers.<
 <dl class="method">
 <dt id="AMPS.Client.publish_flush">
-<code class="descclassname">Client.</code><code class="descname">publish_flush</code><span class="sig-paren">(</span><em>timeout = 0</em>, <em>ack_type = Message.AckType.ProcessedEnum</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.publish_flush" title="Permalink to this definition">¶</a></dt>
-<dd><blockquote>
-<div>Ensures that pending AMPS messages are sent and have been processed by the AMPS server. When the client has a publish store configured, waits until all messages that are in the store at the time the command is called have been acknowledged by AMPS. Otherwise, issues a <code class="docutils literal"><span class="pre">flush</span></code> command and waits for the server to acknowledge that command. This method blocks until messages have been processed or  until the timeout expires, and is most useful when the application reaches a point at which it is acceptable to block to ensure that messages are delivered to the AMPS server. For example, an application might call publish_flush before exiting. One thing to note is that if AMPS is unavailable (HA Client), publish_flush  needs to wait for a connection to come back up which may look like it&#8217;s hanging.</div></blockquote>
+<code class="descclassname">Client.</code><code class="descname">publish_flush</code><span class="sig-paren">(</span><em>timeout=0</em>, <em>ack_type=Message.AckType.ProcessedEnum</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.publish_flush" title="Permalink to this definition">¶</a></dt>
+<dd><p>Ensures that pending AMPS messages are sent and have been processed by the
+AMPS server. When the client has a publish store configured, waits until
+all messages that are in the store at the time the command is called have
+been acknowledged by AMPS. Otherwise, issues a <code class="docutils literal"><span class="pre">flush</span></code> command
+and waits for the server to acknowledge that command.</p>
+<p>This method blocks until messages have been processed or
+until the timeout expires, and is most useful when the application reaches
+a point at which it is acceptable to block to ensure that messages are
+delivered to the AMPS server. For example, an application might call
+<code class="docutils literal"><span class="pre">publish_flush</span></code> before exiting.</p>
+<p>One thing to note is that if AMPS is unavailable (HA Client), <code class="docutils literal"><span class="pre">publish_flush</span></code>
+needs to wait for a connection to come back up, which may look like it&#8217;s hanging.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
@@ -792,9 +915,9 @@ or 0 if there is no publish store and the server is assigning sequence numbers.<
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
 <li><strong>timeout</strong> (<em>int</em>) &#8211; The maximum time to wait for the messages to be acknowledged
 as persisted, or for the flush command to be acknowledged
-by AMPS (in milliseconds), or 0 to wait indefinitely.</li>
+by AMPS (in milliseconds). <code class="docutils literal"><span class="pre">0</span></code> indicates to wait indefinitely.</li>
 <li><strong>ack_type</strong> (<em>int</em>) &#8211; Whether the command should wait for a Processed or a
-Persisted ack when sending the <cite>flush</cite> command.</li>
+Persisted ack when sending the <code class="docutils literal"><span class="pre">flush</span></code> command.</li>
 </ul>
 </td>
 </tr>
@@ -805,19 +928,26 @@ Persisted ack when sending the <cite>flush</cite> command.</li>
 <dl class="method">
 <dt id="AMPS.Client.remove_connection_state_listener">
 <code class="descclassname">Client.</code><code class="descname">remove_connection_state_listener</code><span class="sig-paren">(</span><em>listener_callable</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.remove_connection_state_listener" title="Permalink to this definition">¶</a></dt>
-<dd><p>Removes a listener function previously supplied to add_connection_state_listener.</p>
+<dd><p>Removes a listener function previously supplied to <a class="reference internal" href="#AMPS.Client.add_connection_state_listener" title="AMPS.Client.add_connection_state_listener"><code class="xref py py-meth docutils literal"><span class="pre">add_connection_state_listener()</span></code></a>.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>listener_callable</strong> (<em>A python function</em><em> or </em><em>other callable that takes a single value.</em>) &#8211; The function or callable to be removed.</td>
+</tr>
+</tbody>
+</table>
 </dd></dl>
 <dl class="method">
 <dt id="AMPS.Client.remove_message_handler">
 <code class="descclassname">Client.</code><code class="descname">remove_message_handler</code><span class="sig-paren">(</span><em>command_id</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.remove_message_handler" title="Permalink to this definition">¶</a></dt>
-<dd><blockquote>
-<div>Remove a message handler from the <code class="xref py py-class docutils literal"><span class="pre">Client.</span></code></div></blockquote>
+<dd><p>Remove a message handler from the <a class="reference internal" href="#AMPS.Client" title="AMPS.Client"><code class="xref py py-class docutils literal"><span class="pre">Client</span></code></a>.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>command_id</strong> (<em>str</em>) &#8211; The command_id for the handler to remove.</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>command_id</strong> (<em>str</em>) &#8211; The command ID for the handler to remove.</td>
 </tr>
 </tbody>
 </table>
@@ -826,12 +956,7 @@ Persisted ack when sending the <cite>flush</cite> command.</li>
 <dl class="method">
 <dt id="AMPS.Client.send">
 <code class="descclassname">Client.</code><code class="descname">send</code><span class="sig-paren">(</span><em>message</em>, <em>message_handler=None</em>, <em>timeout=None</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.send" title="Permalink to this definition">¶</a></dt>
-<dd><blockquote>
-<div><dl class="docutils">
-<dt>Send a <a class="reference internal" href="#AMPS.Message" title="AMPS.Message"><code class="xref py py-class docutils literal"><span class="pre">Message</span></code></a> to AMPS via the <code class="xref py py-class docutils literal"><span class="pre">Transport</span></code> used in</dt>
-<dd>the <a class="reference internal" href="#AMPS.Client" title="AMPS.Client"><code class="xref py py-class docutils literal"><span class="pre">Client</span></code></a>.</dd>
-</dl>
-</div></blockquote>
+<dd><p>Send a <a class="reference internal" href="#AMPS.Message" title="AMPS.Message"><code class="xref py py-class docutils literal"><span class="pre">Message</span></code></a> to AMPS via the <code class="xref py py-class docutils literal"><span class="pre">Transport</span></code> used in the <a class="reference internal" href="#AMPS.Client" title="AMPS.Client"><code class="xref py py-class docutils literal"><span class="pre">Client</span></code></a>.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
@@ -857,95 +982,102 @@ one is not assigned.</p>
 <dl class="method">
 <dt id="AMPS.Client.setDisconnectHandler">
 <code class="descclassname">Client.</code><code class="descname">setDisconnectHandler</code><span class="sig-paren">(</span><em>client_disconnect_handler</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.setDisconnectHandler" title="Permalink to this definition">¶</a></dt>
-<dd><dl class="docutils">
-<dt>A legacy method name for <a class="reference internal" href="#AMPS.Client.set_disconnect_handler" title="AMPS.Client.set_disconnect_handler"><code class="xref py py-meth docutils literal"><span class="pre">set_disconnect_handler()</span></code></a></dt>
-<dd><div class="first last deprecated">
+<dd><p>A legacy method name for <a class="reference internal" href="#AMPS.Client.set_disconnect_handler" title="AMPS.Client.set_disconnect_handler"><code class="xref py py-meth docutils literal"><span class="pre">set_disconnect_handler()</span></code></a>.</p>
+<div class="deprecated">
 <p><span class="versionmodified">Deprecated since version 3.2.0.0: </span>Use <a class="reference internal" href="#AMPS.Client.set_disconnect_handler" title="AMPS.Client.set_disconnect_handler"><code class="xref py py-func docutils literal"><span class="pre">set_disconnect_handler()</span></code></a> instead.</p>
 </div>
-</dd>
-</dl>
 </dd></dl>
 <dl class="method">
 <dt id="AMPS.Client.setExceptionListener">
 <code class="descclassname">Client.</code><code class="descname">setExceptionListener</code><span class="sig-paren">(</span><em>exception_listener</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.setExceptionListener" title="Permalink to this definition">¶</a></dt>
-<dd><dl class="docutils">
-<dt>A legacy method name for <a class="reference internal" href="#AMPS.Client.set_exception_listener" title="AMPS.Client.set_exception_listener"><code class="xref py py-meth docutils literal"><span class="pre">set_exception_listener()</span></code></a>.</dt>
-<dd><div class="first last deprecated">
+<dd><p>A legacy method name for <a class="reference internal" href="#AMPS.Client.set_exception_listener" title="AMPS.Client.set_exception_listener"><code class="xref py py-meth docutils literal"><span class="pre">set_exception_listener()</span></code></a>.</p>
+<div class="deprecated">
 <p><span class="versionmodified">Deprecated since version 3.2.0.0: </span>Use <a class="reference internal" href="#AMPS.Client.set_exception_listener" title="AMPS.Client.set_exception_listener"><code class="xref py py-func docutils literal"><span class="pre">set_exception_listener()</span></code></a> instead.</p>
 </div>
-</dd>
-</dl>
 </dd></dl>
 <dl class="method">
 <dt id="AMPS.Client.setName">
 <code class="descclassname">Client.</code><code class="descname">setName</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.setName" title="Permalink to this definition">¶</a></dt>
-<dd><dl class="docutils">
-<dt>A legacy method name for <a class="reference internal" href="#AMPS.Client.set_name" title="AMPS.Client.set_name"><code class="xref py py-meth docutils literal"><span class="pre">set_name()</span></code></a>.</dt>
-<dd><div class="first last deprecated">
+<dd><p>A legacy method name for <a class="reference internal" href="#AMPS.Client.set_name" title="AMPS.Client.set_name"><code class="xref py py-meth docutils literal"><span class="pre">set_name()</span></code></a>.</p>
+<div class="deprecated">
 <p><span class="versionmodified">Deprecated since version 3.2.0.0: </span>Use <a class="reference internal" href="#AMPS.Client.set_name" title="AMPS.Client.set_name"><code class="xref py py-func docutils literal"><span class="pre">set_name()</span></code></a> instead.</p>
 </div>
-</dd>
-</dl>
 </dd></dl>
 <dl class="method">
 <dt id="AMPS.Client.setOnDisconnectHandler">
 <code class="descclassname">Client.</code><code class="descname">setOnDisconnectHandler</code><span class="sig-paren">(</span><em>client_disconnect_handler</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.setOnDisconnectHandler" title="Permalink to this definition">¶</a></dt>
-<dd><dl class="docutils">
-<dt>A legacy method name for <a class="reference internal" href="#AMPS.Client.set_disconnect_handler" title="AMPS.Client.set_disconnect_handler"><code class="xref py py-meth docutils literal"><span class="pre">set_disconnect_handler()</span></code></a></dt>
-<dd><div class="first last deprecated">
+<dd><p>A legacy method name for <a class="reference internal" href="#AMPS.Client.set_disconnect_handler" title="AMPS.Client.set_disconnect_handler"><code class="xref py py-meth docutils literal"><span class="pre">set_disconnect_handler()</span></code></a>.</p>
+<div class="deprecated">
 <p><span class="versionmodified">Deprecated since version 3.2.0.0: </span>Use <a class="reference internal" href="#AMPS.Client.set_disconnect_handler" title="AMPS.Client.set_disconnect_handler"><code class="xref py py-func docutils literal"><span class="pre">set_disconnect_handler()</span></code></a> instead.</p>
 </div>
-</dd>
-</dl>
 </dd></dl>
 <dl class="method">
 <dt id="AMPS.Client.setUnhandledMessageHandler">
 <code class="descclassname">Client.</code><code class="descname">setUnhandledMessageHandler</code><span class="sig-paren">(</span><em>message_handler</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.setUnhandledMessageHandler" title="Permalink to this definition">¶</a></dt>
-<dd><dl class="docutils">
-<dt>A legacy method name for <a class="reference internal" href="#AMPS.Client.set_last_chance_message_handler" title="AMPS.Client.set_last_chance_message_handler"><code class="xref py py-meth docutils literal"><span class="pre">set_last_chance_message_handler()</span></code></a>.</dt>
-<dd><div class="first last deprecated">
+<dd><p>A legacy method name for <a class="reference internal" href="#AMPS.Client.set_last_chance_message_handler" title="AMPS.Client.set_last_chance_message_handler"><code class="xref py py-meth docutils literal"><span class="pre">set_last_chance_message_handler()</span></code></a>.</p>
+<div class="deprecated">
 <p><span class="versionmodified">Deprecated since version 3.2.0.0: </span>Use <a class="reference internal" href="#AMPS.Client.set_last_chance_message_handler" title="AMPS.Client.set_last_chance_message_handler"><code class="xref py py-func docutils literal"><span class="pre">set_last_chance_message_handler()</span></code></a> instead.</p>
 </div>
-</dd>
-</dl>
 </dd></dl>
 <dl class="method">
 <dt id="AMPS.Client.set_ack_batch_size">
 <code class="descclassname">Client.</code><code class="descname">set_ack_batch_size</code><span class="sig-paren">(</span><em>batch_size</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.set_ack_batch_size" title="Permalink to this definition">¶</a></dt>
-<dd><p>Sets the batch size used for batching message queue ACK messages.</p>
-<p>:param batch_size The number of ACK messages to batch before sending.</p>
+<dd><p>Sets the batch size used for batching message queue ack messages.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>batch_size</strong> &#8211; The number of ack messages to batch before sending.</td>
+</tr>
+</tbody>
+</table>
 </dd></dl>
 <dl class="method">
 <dt id="AMPS.Client.set_ack_timeout">
 <code class="descclassname">Client.</code><code class="descname">set_ack_timeout</code><span class="sig-paren">(</span><em>timeout</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.set_ack_timeout" title="Permalink to this definition">¶</a></dt>
 <dd><p>Sets the time before queued ack messages are sent.</p>
-<p>:param timeout The maximum amount of time to wait after adding the first message to an acknowledgement batch before sending the batch, in milliseconds. 0 indicates that the client will wait until the batch is full. A value of 0 is not recommended unless the batch size is set to 1.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>timeout</strong> &#8211; The maximum amount of time to wait after adding the first message to an acknowledgment
+batch before sending the batch, in milliseconds. 0 indicates that the client will wait
+until the batch is full. A value of 0 is not recommended unless the batch size is set to 1.</td>
+</tr>
+</tbody>
+</table>
 </dd></dl>
 <dl class="method">
 <dt id="AMPS.Client.set_auto_ack">
 <code class="descclassname">Client.</code><code class="descname">set_auto_ack</code><span class="sig-paren">(</span><em>enabled</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.set_auto_ack" title="Permalink to this definition">¶</a></dt>
-<dd><p>Enables or disables auto-acknowledgement of message queue messages.</p>
-<p>:param enabled True to enable auto-acknowledgement of message queue messages.</p>
+<dd><p>Enables or disables auto-acknowledgment of message queue messages.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>enabled</strong> (<em>Boolean</em>) &#8211; True to enable auto-acknowledgment of message queue messages.</td>
+</tr>
+</tbody>
+</table>
 </dd></dl>
 <dl class="method">
 <dt id="AMPS.Client.set_bookmark_store">
-<code class="descclassname">Client.</code><code class="descname">set_bookmark_store</code><span class="sig-paren">(</span><em>bookmarkStore</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.set_bookmark_store" title="Permalink to this definition">¶</a></dt>
+<code class="descclassname">Client.</code><code class="descname">set_bookmark_store</code><span class="sig-paren">(</span><em>bookmark_store</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.set_bookmark_store" title="Permalink to this definition">¶</a></dt>
 <dd><p>Sets a bookmark store on self.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>bookmarkStore</strong> &#8211; an <a class="reference internal" href="#AMPS.MMapBookmarkStore" title="AMPS.MMapBookmarkStore"><code class="xref py py-class docutils literal"><span class="pre">MMapBookmarkStore</span></code></a> or
-<a class="reference internal" href="#AMPS.MemoryBookmarkStore" title="AMPS.MemoryBookmarkStore"><code class="xref py py-class docutils literal"><span class="pre">MemoryBookmarkStore</span></code></a> instance, or a custom object that
-implements the required bookmark store methods.</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>bookmark_store</strong> &#8211; A <a class="reference internal" href="#AMPS.MMapBookmarkStore" title="AMPS.MMapBookmarkStore"><code class="xref py py-class docutils literal"><span class="pre">MMapBookmarkStore</span></code></a> or <a class="reference internal" href="#AMPS.MemoryBookmarkStore" title="AMPS.MemoryBookmarkStore"><code class="xref py py-class docutils literal"><span class="pre">MemoryBookmarkStore</span></code></a> instance,
+or a custom object that implements the required bookmark store methods.</td>
 </tr>
 </tbody>
 </table>
@@ -954,26 +1086,23 @@ implements the required bookmark store methods.</td>
 <dl class="method">
 <dt id="AMPS.Client.set_default_max_depth">
 <code class="descclassname">Client.</code><code class="descname">set_default_max_depth</code><span class="sig-paren">(</span><em>depth</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.set_default_max_depth" title="Permalink to this definition">¶</a></dt>
-<dd><blockquote>
-<div><dl class="docutils">
-<dt>Sets a default maximum depth for all new MessageStream objects</dt>
-<dd>that are returned from synchronous API calls such as execute().</dd>
-</dl>
-</div></blockquote>
-<p>:param depth The new depth to use. A depth of 0 means no max and is the default.
-:type depth: int.</p>
+<dd><p>Sets a default maximum depth for all new <code class="docutils literal"><span class="pre">MessageStream</span></code> objects
+that are returned from synchronous API calls such as <a class="reference internal" href="#AMPS.Client.execute" title="AMPS.Client.execute"><code class="xref py py-meth docutils literal"><span class="pre">execute()</span></code></a>.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>depth</strong> (<em>int</em>) &#8211; The new depth to use. A depth of <code class="docutils literal"><span class="pre">0</span></code> means no max and is the default.</td>
+</tr>
+</tbody>
+</table>
 </dd></dl>
 <dl class="method">
 <dt id="AMPS.Client.set_disconnect_handler">
 <code class="descclassname">Client.</code><code class="descname">set_disconnect_handler</code><span class="sig-paren">(</span><em>client_disconnect_handler</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.set_disconnect_handler" title="Permalink to this definition">¶</a></dt>
-<dd><blockquote>
-<div><dl class="docutils">
-<dt>Sets the <code class="xref py py-class docutils literal"><span class="pre">DisconnectHandler</span></code> used by the <a class="reference internal" href="#AMPS.Client" title="AMPS.Client"><code class="xref py py-class docutils literal"><span class="pre">Client</span></code></a>. In</dt>
-<dd>the event that the <cite>Client</cite> is unintentionally disconnected from AMPS, the invoke
-method from the <code class="xref py py-class docutils literal"><span class="pre">ClientDisconnectHandler</span></code> will be invoked.</dd>
-</dl>
-</div></blockquote>
+<dd><p>Sets the <code class="xref py py-class docutils literal"><span class="pre">DisconnectHandler</span></code> used by the <a class="reference internal" href="#AMPS.Client" title="AMPS.Client"><code class="xref py py-class docutils literal"><span class="pre">Client</span></code></a>. In the event that the <cite>Client</cite> is unintentionally
+disconnected from AMPS, the invoke method from the <code class="xref py py-class docutils literal"><span class="pre">ClientDisconnectHandler</span></code> will be invoked.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
@@ -987,18 +1116,13 @@ method from the <code class="xref py py-class docutils literal"><span class="pre
 <dl class="method">
 <dt id="AMPS.Client.set_duplicate_message_handler">
 <code class="descclassname">Client.</code><code class="descname">set_duplicate_message_handler</code><span class="sig-paren">(</span><em>message_handler</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.set_duplicate_message_handler" title="Permalink to this definition">¶</a></dt>
-<dd><blockquote>
-<div><dl class="docutils">
-<dt>Sets the <code class="xref py py-class docutils literal"><span class="pre">MessageHandler</span></code> instance used for messages that arrive from AMPS</dt>
-<dd>that are deemed to be duplicates of previous messages, according to the local bookmark store.</dd>
-</dl>
-</div></blockquote>
+<dd><p>Sets the <code class="xref py py-class docutils literal"><span class="pre">MessageHandler</span></code> instance used for messages that arrive from AMPS that are deemed to be duplicates
+of previous messages, according to the local bookmark store.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>message_handler</strong> (<code class="xref py py-class docutils literal"><span class="pre">MessageHandler</span></code>) &#8211; The message handler to invoke for duplicates
-messages.</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>message_handler</strong> (<code class="xref py py-class docutils literal"><span class="pre">MessageHandler</span></code>) &#8211; The message handler to invoke for duplicate messages.</td>
 </tr>
 </tbody>
 </table>
@@ -1007,14 +1131,13 @@ messages.</td>
 <dl class="method">
 <dt id="AMPS.Client.set_error_on_publish_gap">
 <code class="descclassname">Client.</code><code class="descname">set_error_on_publish_gap</code><span class="sig-paren">(</span><em>error_on_publish_gap</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.set_error_on_publish_gap" title="Permalink to this definition">¶</a></dt>
-<dd><blockquote>
-<div>Called to enable or disable throwing PublishStoreGapException.</div></blockquote>
+<dd><p>Called to enable or disable throwing <a class="reference internal" href="#AMPS.PublishStoreGapException" title="AMPS.PublishStoreGapException"><code class="xref py py-exc docutils literal"><span class="pre">PublishStoreGapException</span></code></a>.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>error_on_publish_gap</strong> (<em>Boolean</em>) &#8211; If true, PublishStoreGapException can be thrown
-by the client publish store if the client logs onto a server that
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>error_on_publish_gap</strong> (<em>Boolean</em>) &#8211; If true, <a class="reference internal" href="#AMPS.PublishStoreGapException" title="AMPS.PublishStoreGapException"><code class="xref py py-exc docutils literal"><span class="pre">PublishStoreGapException</span></code></a> can be thrown by the
+client publish store if the client logs onto a server that
 appears to be missing messages no longer held in the store.</td>
 </tr>
 </tbody>
@@ -1024,18 +1147,12 @@ appears to be missing messages no longer held in the store.</td>
 <dl class="method">
 <dt id="AMPS.Client.set_exception_listener">
 <code class="descclassname">Client.</code><code class="descname">set_exception_listener</code><span class="sig-paren">(</span><em>exception_listener</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.set_exception_listener" title="Permalink to this definition">¶</a></dt>
-<dd><blockquote>
-<div><dl class="docutils">
-<dt>Sets the exception listener instance used for communicating</dt>
-<dd>absorbed exceptions.</dd>
-</dl>
-</div></blockquote>
+<dd><p>Sets the exception listener instance used for communicating absorbed exceptions.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>exception_listener</strong> (<code class="xref py py-exc docutils literal"><span class="pre">Exception</span></code>) &#8211; The exception listener instance to invoke
-for exceptions.</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>exception_listener</strong> (<code class="xref py py-exc docutils literal"><span class="pre">Exception</span></code>) &#8211; The exception listener instance to invoke for exceptions.</td>
 </tr>
 </tbody>
 </table>
@@ -1045,39 +1162,42 @@ for exceptions.</td>
 <dt id="AMPS.Client.set_failed_write_handler">
 <code class="descclassname">Client.</code><code class="descname">set_failed_write_handler</code><span class="sig-paren">(</span><em>failedWriteHandler</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.set_failed_write_handler" title="Permalink to this definition">¶</a></dt>
 <dd><p>Sets a failed write handler on self.</p>
-<table class="docutils field-list" frame="void" rules="none">
-<col class="field-name" />
-<col class="field-body" />
-<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>failedWriteHandler</strong> &#8211; a callable object to be invoked when AMPS indicates that a published message is not written. This could be because a duplicate message already exists in the transaction log, this client is not entitled to publish  to the topic, the message failed to parse, or other similar reasons.
-Parameters to this callable are an AMPS <em>message</em> when the client has a message saved in the publish store, and a string that contains the <em>reason</em> the publish failed.</td>
-</tr>
-</tbody>
-</table>
 <p>For example, you might implement a function like:</p>
 <div class="highlight-default"><div class="highlight"><pre><span></span><span class="k">def</span> <span class="nf">PrintFailedWrites</span><span class="p">(</span><span class="n">message</span><span class="p">,</span> <span class="n">reason</span><span class="p">):</span>
     <span class="n">output</span> <span class="o">=</span> <span class="s2">&quot;Uh-oh, something went wrong writing to AMPS. (</span><span class="si">%s</span><span class="s2">) &quot;</span> <span class="o">%</span> <span class="n">reason</span>
     <span class="k">if</span> <span class="p">(</span><span class="n">message</span> <span class="o">!=</span> <span class="kc">None</span><span class="p">):</span>
-          <span class="n">output</span> <span class="o">+=</span> <span class="s2">&quot;Topic: </span><span class="si">%s</span><span class="s2">, Data snippet: </span><span class="si">%s</span><span class="s2">...&quot;</span> <span class="o">%</span> \
+          <span class="n">output</span> <span class="o">+=</span> <span class="s2">&quot;Topic: </span><span class="si">%s</span><span class="s2">, Data snippet: </span><span class="si">%s</span><span class="s2">...&quot;</span> <span class="o">%</span>
                   <span class="p">(</span><span class="n">message</span><span class="o">.</span><span class="n">get_topic</span><span class="p">(),</span> <span class="n">message</span><span class="o">.</span><span class="n">get_data</span><span class="p">()[</span><span class="mi">0</span><span class="p">:</span><span class="mi">20</span><span class="p">])</span>
     <span class="nb">print</span> <span class="n">output</span>
 </pre></div>
 </div>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>failedWriteHandler</strong> &#8211; A callable object to be invoked when AMPS indicates that a published message is not
+written. This could be because a duplicate message already exists in the transaction
+log, this client is not entitled to publish to the topic, the message failed to parse,
+or other similar reasons.
+Parameters to this callable are an AMPS <em>message</em> when the client has a message saved
+in the publish store, and a string that contains the <em>reason</em> the publish failed.</td>
+</tr>
+</tbody>
+</table>
 </dd></dl>
 <dl class="method">
 <dt id="AMPS.Client.set_global_command_type_message_handler">
 <code class="descclassname">Client.</code><code class="descname">set_global_command_type_message_handler</code><span class="sig-paren">(</span><em>command</em>, <em>message_handler</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.set_global_command_type_message_handler" title="Permalink to this definition">¶</a></dt>
-<dd><blockquote>
-<div>Add a message handler to the <a class="reference internal" href="#AMPS.Client" title="AMPS.Client"><code class="xref py py-class docutils literal"><span class="pre">Client</span></code></a> to handle messages from the
-server with the specified command.</div></blockquote>
+<dd><p>Add a message handler to the <a class="reference internal" href="#AMPS.Client" title="AMPS.Client"><code class="xref py py-class docutils literal"><span class="pre">Client</span></code></a> to handle messages from the
+server with the specified command.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
 <li><strong>command</strong> (<em>str</em>) &#8211; The command to send to the handler.
-Valid values are &#8216;ack&#8217; and &#8216;heartbeat&#8217;.</li>
+Valid values are <code class="docutils literal"><span class="pre">ack</span></code> and <code class="docutils literal"><span class="pre">heartbeat</span></code>.</li>
 <li><strong>message_handler</strong> (<code class="xref py py-class docutils literal"><span class="pre">MessageHandler</span></code>) &#8211; The message handler that will receive messages
 of the command specified.</li>
 </ul>
@@ -1090,34 +1210,29 @@ of the command specified.</li>
 <dl class="method">
 <dt id="AMPS.Client.set_heartbeat">
 <code class="descclassname">Client.</code><code class="descname">set_heartbeat</code><span class="sig-paren">(</span><em>interval_seconds</em>, <em>timeout_seconds=None</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.set_heartbeat" title="Permalink to this definition">¶</a></dt>
-<dd><dl class="docutils">
-<dt>Used to enable heartbeating between the client and the AMPS Server.  When a</dt>
-<dd><blockquote class="first">
-<div><a class="reference internal" href="#AMPS.Client" title="AMPS.Client"><code class="xref py py-class docutils literal"><span class="pre">Client</span></code></a> sends a heartbeat message to an AMPS instance, the AMPS
+<dd><p>Used to enable heartbeating between the client and the AMPS Server.  When a
+<a class="reference internal" href="#AMPS.Client" title="AMPS.Client"><code class="xref py py-class docutils literal"><span class="pre">Client</span></code></a> sends a heartbeat message to an AMPS instance, the AMPS
 instance will send back an acknowledgment message.  From this point forward the
 <a class="reference internal" href="#AMPS.Client" title="AMPS.Client"><code class="xref py py-class docutils literal"><span class="pre">Client</span></code></a> and AMPS instance will each monitor that the other is still active.
 AMPS sends heartbeat messages to the client at the specified interval.
 If the <a class="reference internal" href="#AMPS.Client" title="AMPS.Client"><code class="xref py py-class docutils literal"><span class="pre">Client</span></code></a> does not receive a heartbeat message within
-the time interval specified in :<cite>timeout_seconds</cite>, then the <cite>Client</cite>
+the time interval specified in <code class="docutils literal"><span class="pre">timeout_seconds</span></code>, then the <cite>Client</cite>
 will assume that the connection has ended, close the connection and
 invoke the <code class="xref py py-exc docutils literal"><span class="pre">DisconnectHandler</span></code>. Likewise, if the server
 sends a heartbeat and does not receive a response within the timeout,
 the server will consider the client to be nonresponsive and close
-the connection.</div></blockquote>
-<p class="last">Heartbeats are processed in the client receive thread. If you use
+the connection.</p>
+<p>Heartbeats are processed in the client receive thread. If you use
 asynchronous message processing, your message handler must process
 messages within the timeout interval, or risk being disconnected
 by the server.</p>
-</dd>
-</dl>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
-<li><strong>interval_seconds</strong> (<em>int</em>) &#8211; The time between heartbeat messages being sent
-to AMPS.</li>
-<li><strong>timeout</strong> &#8211; The maximum time to wait for AMPS to acknowledge the start of                 heartbeating (in seconds)</li>
+<li><strong>interval_seconds</strong> (<em>int</em>) &#8211; The time between heartbeat messages being sent to AMPS.</li>
+<li><strong>timeout_seconds</strong> (<em>int</em>) &#8211; The maximum time to wait for AMPS to acknowledge the start of heartbeating (in seconds).</li>
 </ul>
 </td>
 </tr>
@@ -1128,8 +1243,7 @@ to AMPS.</li>
 <dl class="method">
 <dt id="AMPS.Client.set_last_chance_message_handler">
 <code class="descclassname">Client.</code><code class="descname">set_last_chance_message_handler</code><span class="sig-paren">(</span><em>message_handler</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.set_last_chance_message_handler" title="Permalink to this definition">¶</a></dt>
-<dd><blockquote>
-<div>Sets the <code class="xref py py-class docutils literal"><span class="pre">MessageHandler</span></code> instance called when no other incoming message handler matches.</div></blockquote>
+<dd><p>Sets the <code class="xref py py-class docutils literal"><span class="pre">MessageHandler</span></code> instance called when no other incoming message handler matches.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
@@ -1142,13 +1256,13 @@ to AMPS.</li>
 <dl class="method">
 <dt id="AMPS.Client.set_logon_correlation_data">
-<code class="descclassname">Client.</code><code class="descname">set_logon_correlation_data</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.set_logon_correlation_data" title="Permalink to this definition">¶</a></dt>
+<code class="descclassname">Client.</code><code class="descname">set_logon_correlation_data</code><span class="sig-paren">(</span><em>logon_correlation_data</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.set_logon_correlation_data" title="Permalink to this definition">¶</a></dt>
 <dd><p>Sets the data used to correlate the logon of this Client in the server.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>logonCorrelationData</strong> &#8211; The base64 data string to send with the logon.</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>logon_correlation_data</strong> &#8211; The base64 data string to send with the logon.</td>
 </tr>
 </tbody>
 </table>
@@ -1157,18 +1271,26 @@ to AMPS.</li>
 <dl class="method">
 <dt id="AMPS.Client.set_name">
 <code class="descclassname">Client.</code><code class="descname">set_name</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.set_name" title="Permalink to this definition">¶</a></dt>
-<dd><p>A legacy method name for <a class="reference internal" href="#AMPS.Client.set_name" title="AMPS.Client.set_name"><code class="xref py py-meth docutils literal"><span class="pre">set_name()</span></code></a>.</p>
+<dd><p>Sets the <a class="reference internal" href="#AMPS.Client" title="AMPS.Client"><code class="xref py py-class docutils literal"><span class="pre">Client</span></code></a> name.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; The <a class="reference internal" href="#AMPS.Client" title="AMPS.Client"><code class="xref py py-class docutils literal"><span class="pre">Client</span></code></a> name.</td>
+</tr>
+</tbody>
+</table>
 </dd></dl>
 <dl class="method">
 <dt id="AMPS.Client.set_publish_store">
-<code class="descclassname">Client.</code><code class="descname">set_publish_store</code><span class="sig-paren">(</span><em>publishStore</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.set_publish_store" title="Permalink to this definition">¶</a></dt>
+<code class="descclassname">Client.</code><code class="descname">set_publish_store</code><span class="sig-paren">(</span><em>publish_store</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.set_publish_store" title="Permalink to this definition">¶</a></dt>
 <dd><p>Sets a publish store on self.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>publishStore</strong> &#8211; an <a class="reference internal" href="#AMPS.PublishStore" title="AMPS.PublishStore"><code class="xref py py-class docutils literal"><span class="pre">PublishStore</span></code></a> or <a class="reference internal" href="#AMPS.MemoryPublishStore" title="AMPS.MemoryPublishStore"><code class="xref py py-class docutils literal"><span class="pre">MemoryPublishStore</span></code></a> instance.</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>publish_store</strong> &#8211; a <a class="reference internal" href="#AMPS.PublishStore" title="AMPS.PublishStore"><code class="xref py py-class docutils literal"><span class="pre">PublishStore</span></code></a> or <a class="reference internal" href="#AMPS.MemoryPublishStore" title="AMPS.MemoryPublishStore"><code class="xref py py-class docutils literal"><span class="pre">MemoryPublishStore</span></code></a> instance.</td>
 </tr>
 </tbody>
 </table>
@@ -1177,18 +1299,24 @@ to AMPS.</li>
 <dl class="method">
 <dt id="AMPS.Client.set_retry_on_disconnect">
 <code class="descclassname">Client.</code><code class="descname">set_retry_on_disconnect</code><span class="sig-paren">(</span><em>enabled</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.set_retry_on_disconnect" title="Permalink to this definition">¶</a></dt>
-<dd><blockquote>
-<div><dl class="docutils">
-<dt>Enables or disables automatic retry of a command to AMPS after a</dt>
-<dd>reconnect. This behavior is enabled by default.
-NOTE: Clients using a publish store will have all publish
+<dd><p>Enables or disables automatic retry of a command to AMPS after a reconnect. This behavior is enabled by default.</p>
+<blockquote>
+<div><div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p class="last">Clients using a publish store will have all publish
 messages sent, regardless of this setting. Also, Clients with
 a subscription manager, including all HAClients, will have all
-subscribe calls placed.</dd>
-</dl>
+subscribe calls placed.</p>
+</div>
 </div></blockquote>
-<p>:param enabled False to disable automatic retry of commands to AMPS.
-:type enabled: Boolean.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>enabled</strong> (<em>Boolean</em>) &#8211; False to disable automatic retry of commands to AMPS.</td>
+</tr>
+</tbody>
+</table>
 </dd></dl>
 <dl class="method">
@@ -1213,6 +1341,10 @@ subscribe calls placed.</dd>
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>transport_filter_callable</strong> (<em>A python function</em><em> or </em><em>other callable that takes two parameters: data and direction.</em>) &#8211; The function or callable to be called. This function is passed a string (&#8216;data&#8217;)
+containing the raw bytes sent or received. The &#8216;direction&#8217; parameter is False if
+the data is being sent to the server, or True if data is received from the server.</td>
+</tr>
 </tbody>
 </table>
 </dd></dl>
@@ -1220,62 +1352,71 @@ subscribe calls placed.</dd>
 <dl class="method">
 <dt id="AMPS.Client.set_unhandled_message_handler">
 <code class="descclassname">Client.</code><code class="descname">set_unhandled_message_handler</code><span class="sig-paren">(</span><em>message_handler</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.set_unhandled_message_handler" title="Permalink to this definition">¶</a></dt>
-<dd><dl class="docutils">
-<dt>A legacy method name for <a class="reference internal" href="#AMPS.Client.set_last_chance_message_handler" title="AMPS.Client.set_last_chance_message_handler"><code class="xref py py-meth docutils literal"><span class="pre">set_last_chance_message_handler()</span></code></a>.</dt>
-<dd><div class="first last deprecated">
+<dd><p>A legacy method name for <a class="reference internal" href="#AMPS.Client.set_last_chance_message_handler" title="AMPS.Client.set_last_chance_message_handler"><code class="xref py py-meth docutils literal"><span class="pre">set_last_chance_message_handler()</span></code></a>.</p>
+<div class="deprecated">
 <p><span class="versionmodified">Deprecated since version 4.0.0.0: </span>Use <a class="reference internal" href="#AMPS.Client.set_last_chance_message_handler" title="AMPS.Client.set_last_chance_message_handler"><code class="xref py py-func docutils literal"><span class="pre">set_last_chance_message_handler()</span></code></a> instead.</p>
 </div>
-</dd>
-</dl>
 </dd></dl>
 <dl class="method">
 <dt id="AMPS.Client.sow">
-<code class="descclassname">Client.</code><code class="descname">sow</code><span class="sig-paren">(</span><em>on_message</em>, <em>topic</em>, <em>filter=None</em>, <em>batch_size=10</em>, <em>timeout=0</em>, <em>top_n=None</em>, <em>order_by=None</em>, <em>bookmark=None</em>, <em>options=None</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.sow" title="Permalink to this definition">¶</a></dt>
-<dd><p>Executes a SOW query. There are two ways to use this method.
-First, you can provide a topic, filter, and options for the subscription.
-In this case, the method returns a message stream that you can iterate over.
-For example:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">c</span> <span class="o">=</span> <span class="n">Client</span><span class="p">(</span><span class="s2">&quot;test_client&quot;</span><span class="p">)</span>
+<code class="descclassname">Client.</code><code class="descname">sow</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.sow" title="Permalink to this definition">¶</a></dt>
+<dd><p><strong>Signatures</strong>:</p>
+<ul>
+<li><p class="first"><code class="docutils literal"><span class="pre">Client.sow(on_message,</span> <span class="pre">topic,</span> <span class="pre">filter=None,</span> <span class="pre">batch_size=10,</span> <span class="pre">timeout=0,</span> <span class="pre">top_n=None,</span> <span class="pre">order_by=None,</span> <span class="pre">bookmark=None,</span> <span class="pre">options=0)</span></code></p>
+</li>
+<li><p class="first"><code class="docutils literal"><span class="pre">Client.sow(topic,</span> <span class="pre">filter=None,</span> <span class="pre">batch_size=10,</span> <span class="pre">timeout=0,</span> <span class="pre">top_n=None,</span> <span class="pre">order_by=None,</span> <span class="pre">bookmark=None,</span> <span class="pre">options=0)</span></code></p>
+<p>Executes a SOW query.</p>
+<p>There are two ways to use this method:</p>
+<ol class="arabic simple">
+<li>When a message handler is provided, this method submits the SOW query on a background thread and calls the
+message handler with individual messages, including the <code class="docutils literal"><span class="pre">group_begin</span></code> and <code class="docutils literal"><span class="pre">group_end</span></code> messages, that indicate
+the beginning and end of the SOW results.</li>
+<li>When no message handler is provided, this method returns a message stream that can be iterated on to process
+messages received including the <code class="docutils literal"><span class="pre">group_begin</span></code> and <code class="docutils literal"><span class="pre">group_end</span></code> messages, that indicate the beginning and end of
+the SOW results.</li>
+</ol>
+</li>
+</ul>
+<p>For example:</p>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">client</span> <span class="o">=</span> <span class="n">AMPS</span><span class="o">.</span><span class="n">Client</span><span class="p">(</span><span class="s2">&quot;test_client&quot;</span><span class="p">)</span>
 <span class="k">try</span><span class="p">:</span>
-    <span class="n">c</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="s2">&quot;tcp://127.0.0.1:9004/fix&quot;</span><span class="p">)</span>
-    <span class="n">cid</span> <span class="o">=</span> <span class="n">c</span><span class="o">.</span><span class="n">logon</span><span class="p">(</span><span class="n">timeout</span><span class="o">=</span><span class="mi">0</span><span class="p">)</span>
-    <span class="k">for</span> <span class="n">aMessage</span> <span class="ow">in</span> <span class="n">c</span><span class="o">.</span><span class="n">sow</span><span class="p">(</span><span class="s2">&quot;MySowTopic&quot;</span><span class="p">):</span>
-        <span class="nb">print</span> <span class="n">aMessage</span><span class="o">.</span><span class="n">get_data</span><span class="p">()</span>
+    <span class="n">client</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="s2">&quot;tcp://127.0.0.1:9004/amps/fix&quot;</span><span class="p">)</span>
+    <span class="n">client</span><span class="o">.</span><span class="n">logon</span><span class="p">()</span>
+    <span class="k">for</span> <span class="n">message</span> <span class="ow">in</span> <span class="n">client</span><span class="o">.</span><span class="n">sow</span><span class="p">(</span><span class="s2">&quot;MySowTopic&quot;</span><span class="p">):</span>
+        <span class="nb">print</span><span class="p">(</span><span class="n">message</span><span class="o">.</span><span class="n">get_data</span><span class="p">())</span>
 <span class="k">finally</span><span class="p">:</span>
-    <span class="n">c</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
+    <span class="n">client</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
 </pre></div>
 </div>
-<p>Second, you can provide a message handler. In this case, the method creates
-a background thread and calls the message handler with each message
-received from AMPS, including the <cite>group_begin</cite> and <cite>group_end</cite> messages
-that indicate the beginning and end of the SOW query.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
 <li><strong>on_message</strong> (<code class="xref py py-class docutils literal"><span class="pre">MessageHandler</span></code>) &#8211; The message handler to invoke with matching
-messages. If this parameter is not present, AMPS creates a
-:class: <cite>MessageStream</cite> and returns that message stream
-from the call to sow.</li>
+messages. If this parameter is not present, AMPS creates a
+<a class="reference internal" href="#AMPS.MessageStream" title="AMPS.MessageStream"><code class="xref py py-class docutils literal"><span class="pre">MessageStream</span></code></a> and returns that message stream
+from the call to sow (specified only in the case where async
+processing is used).</li>
 <li><strong>topic</strong> (<em>str</em>) &#8211; The topic to execute the SOW query against.</li>
 <li><strong>filter</strong> (<em>str</em>) &#8211; The filter.</li>
 <li><strong>batch_size</strong> (<em>int</em>) &#8211; The batching parameter to use for the results.</li>
-<li><strong>timeout</strong> (<em>int</em>) &#8211; The maximum time to wait for the client to receive and
+<li><strong>timeout</strong> (<em>int</em>) &#8211; The maximum time to wait for the client to receive and
 consume a processed ack for this command (in milliseconds).
 <code class="docutils literal"><span class="pre">0</span></code> indicates to wait indefinitely.</li>
-<li><strong>top_n</strong> (<em>int</em>) &#8211; The maximum number of records to return from the sow.</li>
+<li><strong>top_n</strong> (<em>int</em>) &#8211; The maximum number of records to return from the SOW.</li>
 <li><strong>order_by</strong> (<em>str</em>) &#8211; To have the records ordered by the server.</li>
-<li><strong>bookmark</strong> (<em>int</em>) &#8211; The bookmark for historical query of the sow.</li>
+<li><strong>bookmark</strong> (<em>int</em>) &#8211; The bookmark for historical query of the SOW.</li>
 <li><strong>options</strong> (<em>str</em>) &#8211; A comma separated list of values indicating additional
 processing options.</li>
 </ul>
 </td>
 </tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">If a message handler is provided, returns the command identifier
-assigned to this command. If no message handler is present,           returns a MessageStream containing the results of the command.</p>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The command identifier assigned to this command if a message handler was provided.
+If no message handler was provided, returns a <code class="docutils literal"><span class="pre">MessageStream</span></code> containing the
+results of the command.</p>
 </td>
 </tr>
 <tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last"><a class="reference internal" href="#AMPS.BadFilterException" title="AMPS.BadFilterException"><code class="xref py py-exc docutils literal"><span class="pre">BadFilterException</span></code></a>, <a class="reference internal" href="#AMPS.BadRegexTopicException" title="AMPS.BadRegexTopicException"><code class="xref py py-exc docutils literal"><span class="pre">BadRegexTopicException</span></code></a>,
@@ -1289,68 +1430,77 @@ assigned to this command. If no message handler is present,           returns a
 <dl class="method">
 <dt id="AMPS.Client.sowAndDeltaSubscribe">
 <code class="descclassname">Client.</code><code class="descname">sowAndDeltaSubscribe</code><span class="sig-paren">(</span><em>on_message</em>, <em>topic</em>, <em>filter=None</em>, <em>batch_size=1</em>, <em>oof_enabled=False</em>, <em>send_empties=False</em>, <em>options=0</em>, <em>timeout=0</em>, <em>top_n=None</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.sowAndDeltaSubscribe" title="Permalink to this definition">¶</a></dt>
-<dd><dl class="docutils">
-<dt>A legacy method name for <a class="reference internal" href="#AMPS.Client.sow_and_delta_subscribe" title="AMPS.Client.sow_and_delta_subscribe"><code class="xref py py-meth docutils literal"><span class="pre">sow_and_delta_subscribe()</span></code></a>.</dt>
-<dd><div class="first last deprecated">
+<dd><p>A legacy method name for <a class="reference internal" href="#AMPS.Client.sow_and_delta_subscribe" title="AMPS.Client.sow_and_delta_subscribe"><code class="xref py py-meth docutils literal"><span class="pre">sow_and_delta_subscribe()</span></code></a>.</p>
+<div class="deprecated">
 <p><span class="versionmodified">Deprecated since version 3.2.0.0: </span>Use <a class="reference internal" href="#AMPS.Client.sow_and_delta_subscribe" title="AMPS.Client.sow_and_delta_subscribe"><code class="xref py py-func docutils literal"><span class="pre">sow_and_delta_subscribe()</span></code></a> instead.</p>
 </div>
-</dd>
-</dl>
 </dd></dl>
 <dl class="method">
 <dt id="AMPS.Client.sowAndSubscribe">
 <code class="descclassname">Client.</code><code class="descname">sowAndSubscribe</code><span class="sig-paren">(</span><em>on_message</em>, <em>topic</em>, <em>filter</em>, <em>batch_size=1</em>, <em>oof_enabled=False</em>, <em>options=0</em>, <em>timeout=0</em>, <em>top_n=None</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.sowAndSubscribe" title="Permalink to this definition">¶</a></dt>
-<dd><dl class="docutils">
-<dt>A legacy method name for <a class="reference internal" href="#AMPS.Client.sow_and_subscribe" title="AMPS.Client.sow_and_subscribe"><code class="xref py py-meth docutils literal"><span class="pre">sow_and_subscribe()</span></code></a>.</dt>
-<dd><div class="first last deprecated">
+<dd><p>A legacy method name for <a class="reference internal" href="#AMPS.Client.sow_and_subscribe" title="AMPS.Client.sow_and_subscribe"><code class="xref py py-meth docutils literal"><span class="pre">sow_and_subscribe()</span></code></a>.</p>
+<div class="deprecated">
 <p><span class="versionmodified">Deprecated since version 3.2.0.0: </span>Use <a class="reference internal" href="#AMPS.Client.sow_and_subscribe" title="AMPS.Client.sow_and_subscribe"><code class="xref py py-func docutils literal"><span class="pre">sow_and_subscribe()</span></code></a> instead.</p>
 </div>
-</dd>
-</dl>
 </dd></dl>
 <dl class="method">
 <dt id="AMPS.Client.sowDelete">
-<code class="descclassname">Client.</code><code class="descname">sowDelete</code><span class="sig-paren">(</span><em>on_message</em>, <em>topic</em>, <em>filter=None</em>, <em>options=0</em>, <em>timeout=0</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.sowDelete" title="Permalink to this definition">¶</a></dt>
-<dd><dl class="docutils">
-<dt>A legacy method name for <a class="reference internal" href="#AMPS.Client.sow_delete" title="AMPS.Client.sow_delete"><code class="xref py py-meth docutils literal"><span class="pre">sow_delete()</span></code></a>.</dt>
-<dd><div class="first last deprecated">
+<code class="descclassname">Client.</code><code class="descname">sowDelete</code><span class="sig-paren">(</span><em>on_message</em>, <em>topic</em>, <em>filter=None</em>, <em>timeout=0</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.sowDelete" title="Permalink to this definition">¶</a></dt>
+<dd><p>A legacy method name for <a class="reference internal" href="#AMPS.Client.sow_delete" title="AMPS.Client.sow_delete"><code class="xref py py-meth docutils literal"><span class="pre">sow_delete()</span></code></a>.</p>
+<div class="deprecated">
 <p><span class="versionmodified">Deprecated since version 3.2.0.0: </span>Use <a class="reference internal" href="#AMPS.Client.sow_delete" title="AMPS.Client.sow_delete"><code class="xref py py-func docutils literal"><span class="pre">sow_delete()</span></code></a> instead.</p>
 </div>
-</dd>
-</dl>
 </dd></dl>
 <dl class="method">
 <dt id="AMPS.Client.sow_and_delta_subscribe">
-<code class="descclassname">Client.</code><code class="descname">sow_and_delta_subscribe</code><span class="sig-paren">(</span><em>on_message</em>, <em>topic</em>, <em>filter=None</em>, <em>batch_size=1</em>, <em>oof_enabled=False</em>, <em>send_empties=False</em>, <em>options=0</em>, <em>timeout=0</em>, <em>top_n=None</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.sow_and_delta_subscribe" title="Permalink to this definition">¶</a></dt>
-<dd><p>Executes a SOW query and places a delta subscription.</p>
+<code class="descclassname">Client.</code><code class="descname">sow_and_delta_subscribe</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.sow_and_delta_subscribe" title="Permalink to this definition">¶</a></dt>
+<dd><p><strong>Signatures</strong>:</p>
+<ul>
+<li><p class="first"><code class="docutils literal"><span class="pre">Client.sow_and_delta_subscribe(on_message,</span> <span class="pre">topic,</span> <span class="pre">filter=None,</span> <span class="pre">batch_size=1,</span> <span class="pre">oof_enabled=False,</span> <span class="pre">send_empties=False,</span> <span class="pre">timeout=0,</span> <span class="pre">top_n=None,</span> <span class="pre">order_by=None,</span> <span class="pre">options=None)</span></code></p>
+</li>
+<li><p class="first"><code class="docutils literal"><span class="pre">Client.sow_and_delta_subscribe(topic,</span> <span class="pre">filter=None,</span> <span class="pre">batch_size=1,</span> <span class="pre">oof_enabled=False,</span> <span class="pre">send_empties=False,</span> <span class="pre">timeout=0,</span> <span class="pre">top_n=None,</span> <span class="pre">order_by=None,</span> <span class="pre">options=None)</span></code></p>
+<p>Executes a SOW query and places a delta subscription.</p>
+<p>There are two ways to use this method:</p>
+<ol class="arabic simple">
+<li>When a message handler is provided, this method submits the <code class="docutils literal"><span class="pre">sow_and_delta_subscribe</span></code> command on a background
+thread and calls the message handler with individual messages received from the SOW query, including the
+<code class="docutils literal"><span class="pre">group_begin</span></code> and <code class="docutils literal"><span class="pre">group_end</span></code> messages, that indicate the beginning and end of the SOW results and then with
+messages received that match the subscription and that contain the updated fields.</li>
+<li>When no message handler is provided, this method returns a message stream that can be iterated on to process
+messages received from the SOW query, including the <code class="docutils literal"><span class="pre">group_begin</span></code> and <code class="docutils literal"><span class="pre">group_end</span></code> messages, that indicate the
+beginning and end of the SOW results and then processes messages received that match the subscription and that
+contain the updated fields.</li>
+</ol>
+</li>
+</ul>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
 <li><strong>on_message</strong> (<code class="xref py py-class docutils literal"><span class="pre">MessageHandler</span></code>) &#8211; The message handler to invoke with matching
-messages.</li>
-<li><strong>topic</strong> (<em>str</em>) &#8211; The <cite>Topic</cite> to execute the SOW query against.</li>
+messages (specified only in the case where async processing is used).</li>
+<li><strong>topic</strong> (<em>str</em>) &#8211; The topic to execute the SOW query against.</li>
 <li><strong>filter</strong> (<em>str</em>) &#8211; The filter.</li>
 <li><strong>batch_size</strong> (<em>int</em>) &#8211; The batch sizing parameter to use for the results.</li>
-<li><strong>oof_enabled</strong> (<em>boolean</em>) &#8211; Specifies whether or not Out-of-Focus processing is
-enabled.</li>
+<li><strong>oof_enabled</strong> (<em>boolean</em>) &#8211; Specifies whether or not Out-of-Focus processing is enabled.</li>
 <li><strong>send_empties</strong> (<em>boolean</em>) &#8211; Specifies whether or not unchanged records are
 received on the delta subscription.</li>
-<li><strong>timeout</strong> (<em>int</em>) &#8211; The maximum time to wait for the client to receive and
+<li><strong>timeout</strong> (<em>int</em>) &#8211; The maximum time to wait for the client to receive and
 consume the processed ack for this command (in milliseconds).
 <code class="docutils literal"><span class="pre">0</span></code> indicates to wait indefinitely.</li>
-<li><strong>top_n</strong> (<em>int</em>) &#8211; The maximum number of records to return from the sow.</li>
+<li><strong>top_n</strong> (<em>int</em>) &#8211; The maximum number of records to return from the SOW.</li>
 <li><strong>order_by</strong> (<em>str</em>) &#8211; To have the records ordered by the server.</li>
-<li><strong>options</strong> (<em>str</em>) &#8211; A comma separated list of values indicating additional
-processing options.</li>
+<li><strong>options</strong> (<em>str</em>) &#8211; A comma separated list of values indicating additional processing options.</li>
 </ul>
 </td>
 </tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The command identifier assigned to this command.</p>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The command identifier assigned to this command if a message handler was provided.
+If no message handler was provided, returns a <code class="docutils literal"><span class="pre">MessageStream</span></code> containing the results
+of the command.</p>
 </td>
 </tr>
 <tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last"><a class="reference internal" href="#AMPS.SubscriptionAlreadyExistsException" title="AMPS.SubscriptionAlreadyExistsException"><code class="xref py py-exc docutils literal"><span class="pre">SubscriptionAlreadyExistsException</span></code></a>,
@@ -1364,32 +1514,49 @@ processing options.</li>
 <dl class="method">
 <dt id="AMPS.Client.sow_and_subscribe">
-<code class="descclassname">Client.</code><code class="descname">sow_and_subscribe</code><span class="sig-paren">(</span><em>on_message</em>, <em>topic</em>, <em>filter</em>, <em>batch_size=1</em>, <em>oof_enabled=False</em>, <em>timeout=0</em>, <em>top_n=None</em>, <em>order_by=</em>, <em>bookmark=</em>, <em>options=</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.sow_and_subscribe" title="Permalink to this definition">¶</a></dt>
-<dd><p>Executes a SOW query and places a subscription.</p>
+<code class="descclassname">Client.</code><code class="descname">sow_and_subscribe</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.sow_and_subscribe" title="Permalink to this definition">¶</a></dt>
+<dd><p><strong>Signatures</strong>:</p>
+<ul>
+<li><p class="first"><code class="docutils literal"><span class="pre">Client.sow_and_subscribe(on_message,</span> <span class="pre">topic,</span> <span class="pre">filter=None,</span> <span class="pre">batch_size=1,</span> <span class="pre">oof_enabled=False,</span> <span class="pre">timeout=0,</span> <span class="pre">top_n=None,</span> <span class="pre">order_by=None,</span> <span class="pre">bookmark=None,</span> <span class="pre">options=None)</span></code></p>
+</li>
+<li><p class="first"><code class="docutils literal"><span class="pre">Client.sow_and_subscribe(topic,</span> <span class="pre">filter=None,</span> <span class="pre">batch_size=1,</span> <span class="pre">oof_enabled=False,</span> <span class="pre">timeout=0,</span> <span class="pre">top_n=None,</span> <span class="pre">order_by=None,</span> <span class="pre">bookmark=None,</span> <span class="pre">options=None)</span></code></p>
+<p>Executes a SOW query and places a subscription.</p>
+<p>There are two ways to use this method:</p>
+<ol class="arabic simple">
+<li>When a message handler is provided, this method submits the <code class="docutils literal"><span class="pre">sow_and_subscribe</span></code> command on a background thread
+and calls the message handler with individual messages received from the SOW query, including the <code class="docutils literal"><span class="pre">group_begin</span></code>
+and <code class="docutils literal"><span class="pre">group_end</span></code> messages, that indicate the beginning and end of the SOW results and then with messages received
+that match the subscription.</li>
+<li>When no message handler is provided, this method returns a message stream that can be iterated on to process
+messages received from the SOW query, including the <code class="docutils literal"><span class="pre">group_begin</span></code> and <code class="docutils literal"><span class="pre">group_end</span></code> messages, that indicate the
+beginning and end of the SOW results and then processes messages received that match the subscription.</li>
+</ol>
+</li>
+</ul>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
 <li><strong>on_message</strong> (<code class="xref py py-class docutils literal"><span class="pre">MessageHandler</span></code>) &#8211; The message handler to invoke with matching
-messages.</li>
+messages (specified only in the case where async processing is used).</li>
 <li><strong>topic</strong> (<em>str</em>) &#8211; The topic to execute the SOW query against.</li>
 <li><strong>filter</strong> (<em>str</em>) &#8211; The filter.</li>
 <li><strong>batch_size</strong> (<em>int</em>) &#8211; The batching parameter to use for the results.</li>
-<li><strong>oof_enabled</strong> (<em>boolean</em>) &#8211; Specifies whether or not Out-of-Focus processing is
-enabled.</li>
+<li><strong>oof_enabled</strong> (<em>boolean</em>) &#8211; Specifies whether or not Out-of-Focus processing is enabled.</li>
 <li><strong>timeout</strong> (<em>int</em>) &#8211; The maximum time to wait for the client to receive and
-consume the processed ack for this command
-(in milliseconds). <code class="docutils literal"><span class="pre">0</span></code> indicates to wait indefinitely.</li>
-<li><strong>top_n</strong> (<em>int</em>) &#8211; The maximum number of records to return from the sow.</li>
+consume the processed ack for this command (in milliseconds).
+<code class="docutils literal"><span class="pre">0</span></code> indicates to wait indefinitely.</li>
+<li><strong>top_n</strong> (<em>int</em>) &#8211; The maximum number of records to return from the SOW.</li>
 <li><strong>order_by</strong> (<em>str</em>) &#8211; To have the records ordered by the server.</li>
-<li><strong>bookmark</strong> (<em>str</em>) &#8211; The bookmark for historical query of the sow.</li>
-<li><strong>options</strong> (<em>str</em>) &#8211; A comma separated list of values indicating additional
-processing options.</li>
+<li><strong>bookmark</strong> (<em>str</em>) &#8211; The bookmark for historical query of the SOW.</li>
+<li><strong>options</strong> (<em>str</em>) &#8211; A comma separated list of values indicating additional processing options.</li>
 </ul>
 </td>
 </tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The command identifier assigned to this command.</p>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The command identifier assigned to this command if a message handler was provided.
+If no message handler was provided, returns a <code class="docutils literal"><span class="pre">MessageStream</span></code> containing the results
+of the command.</p>
 </td>
 </tr>
 <tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last"><a class="reference internal" href="#AMPS.SubscriptionAlreadyExistsException" title="AMPS.SubscriptionAlreadyExistsException"><code class="xref py py-exc docutils literal"><span class="pre">SubscriptionAlreadyExistsException</span></code></a>,
@@ -1403,18 +1570,26 @@ processing options.</li>
 <dl class="method">
 <dt id="AMPS.Client.sow_delete">
-<code class="descclassname">Client.</code><code class="descname">sow_delete</code><span class="sig-paren">(</span><em>on_message</em>, <em>topic</em>, <em>filter=None</em>, <em>options=0</em>, <em>timeout=0</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.sow_delete" title="Permalink to this definition">¶</a></dt>
-<dd><p>Executes a SOW delete with a filter.</p>
-<p>There are two ways to use this method. When no message handler is provided,
-the method returns a <a class="reference internal" href="#AMPS.Message" title="AMPS.Message"><code class="xref py py-class docutils literal"><span class="pre">Message</span></code></a> that will receive the results
-of the delete command.</p>
-<p>When a message handler is provided, this method submits the SOW delete on a
-background thread and calls the message handler with the results of the
-delete.</p>
+<code class="descclassname">Client.</code><code class="descname">sow_delete</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.sow_delete" title="Permalink to this definition">¶</a></dt>
+<dd><p><strong>Signatures</strong>:</p>
+<ul>
+<li><p class="first"><code class="docutils literal"><span class="pre">Client.sow_delete(on_message,</span> <span class="pre">topic,</span> <span class="pre">filter=None,</span> <span class="pre">timeout=0)</span></code></p>
+</li>
+<li><p class="first"><code class="docutils literal"><span class="pre">Client.sow_delete(topic,</span> <span class="pre">filter=None,</span> <span class="pre">timeout=0)</span></code></p>
+<p>Executes a SOW delete with a filter.</p>
+<p>There are two ways to use this method:</p>
+<ol class="arabic simple">
+<li>When a message handler is provided, this method submits the <code class="docutils literal"><span class="pre">sow_delete</span></code> command on a background thread and
+calls the message handler with the results of the delete.</li>
+<li>When no message handler is provided, this method returns an acknowledgment message with the result of the
+delete command.</li>
+</ol>
+</li>
+</ul>
 <p>For example, to delete all messages that match a filter:</p>
 <div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">...</span>
 <span class="n">ackMessage</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">sow_delete</span><span class="p">(</span><span class="s2">&quot;sow_topic&quot;</span><span class="p">,</span><span class="s2">&quot;/status = &#39;obsolete&#39;&quot;</span><span class="p">)</span>
-<span class="nb">print</span> <span class="s2">&quot;</span><span class="si">%s</span><span class="s2">: </span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">ackMessage</span><span class="o">.</span><span class="n">get_ack_type</span><span class="p">(),</span> <span class="n">ackMessage</span><span class="o">.</span><span class="n">get_status</span><span class="p">())</span>
+<span class="nb">print</span><span class="p">(</span><span class="s2">&quot;</span><span class="si">%s</span><span class="s2">: </span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">ackMessage</span><span class="o">.</span><span class="n">get_ack_type</span><span class="p">(),</span> <span class="n">ackMessage</span><span class="o">.</span><span class="n">get_status</span><span class="p">()))</span>
 <span class="o">...</span>
 </pre></div>
 </div>
@@ -1423,19 +1598,18 @@ delete.</p>
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
-<li><strong>on_message</strong> (<code class="xref py py-exc docutils literal"><span class="pre">MessageHandler</span></code>) &#8211; The message handler to invoke with <cite>stats</cite> and
-<cite>completed</cite> acknowledgments</li>
+<li><strong>on_message</strong> (<code class="xref py py-exc docutils literal"><span class="pre">MessageHandler</span></code>) &#8211; The message handler to invoke with <cite>stats</cite> and <cite>completed</cite> acknowledgments
+(specified only in the case where async processing is used).</li>
 <li><strong>topic</strong> (<em>str</em>) &#8211; The topic to execute the SOW delete against.</li>
-<li><strong>filter</strong> (<em>str</em>) &#8211; The filter. To delete all records, set a filter that is always true (&#8216;1=1&#8217;)</li>
-<li><strong>options</strong> (<em>str</em>) &#8211; A comma separated list of values indicating additional
-processing options.</li>
+<li><strong>filter</strong> (<em>str</em>) &#8211; The filter. To delete all records, set a filter that is always true (&#8216;1=1&#8217;).</li>
 <li><strong>timeout</strong> (<em>int</em>) &#8211; The maximum time to wait for the client to receive and
 consume the processed ack for this command (in milliseconds).
 <code class="docutils literal"><span class="pre">0</span></code> indicates to wait indefinitely.</li>
 </ul>
 </td>
 </tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The command identifier assigned to this command.</p>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The command identifier assigned to this command if a message handler was provided.
+If no message handler was provided, returns an acknowledgment.</p>
 </td>
 </tr>
 <tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last"><a class="reference internal" href="#AMPS.BadFilterException" title="AMPS.BadFilterException"><code class="xref py py-exc docutils literal"><span class="pre">BadFilterException</span></code></a>, <a class="reference internal" href="#AMPS.BadRegexTopicException" title="AMPS.BadRegexTopicException"><code class="xref py py-exc docutils literal"><span class="pre">BadRegexTopicException</span></code></a>,
@@ -1448,31 +1622,36 @@ consume the processed ack for this command (in milliseconds).
 <dl class="method">
 <dt id="AMPS.Client.sow_delete_by_data">
-<code class="descclassname">Client.</code><code class="descname">sow_delete_by_data</code><span class="sig-paren">(</span><em>on_message</em>, <em>topic</em>, <em>data</em>, <em>timeout=0</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.sow_delete_by_data" title="Permalink to this definition">¶</a></dt>
-<dd><p>Delete a message from a SOW, using data supplied to locate a SOW entry with  matching keys.</p>
-<p>There are two ways to use this method. When no message handler is provided,
-the method returns a <a class="reference internal" href="#AMPS.Message" title="AMPS.Message"><code class="xref py py-class docutils literal"><span class="pre">Message</span></code></a> that will receive the results
-of the delete command.</p>
-<p>When a message handler is provided, this method submits the SOW delete on a
-background thread and calls the message handler with the results of the
-delete.</p>
-<p>For example, to efficiently delete a message that your program has
-received from AMPS:</p>
+<code class="descclassname">Client.</code><code class="descname">sow_delete_by_data</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.sow_delete_by_data" title="Permalink to this definition">¶</a></dt>
+<dd><p><strong>Signatures</strong>:</p>
+<ul>
+<li><p class="first"><code class="docutils literal"><span class="pre">Client.sow_delete_by_data(on_message,</span> <span class="pre">topic,</span> <span class="pre">data,</span> <span class="pre">timeout=0)</span></code></p>
+</li>
+<li><p class="first"><code class="docutils literal"><span class="pre">Client.sow_delete_by_data(topic,</span> <span class="pre">data,</span> <span class="pre">timeout=0)</span></code></p>
+<p>Executes a SOW delete using the provided message data to determine the SOW key of the record to delete.</p>
+<p>There are two ways to use this method:</p>
+<ol class="arabic simple">
+<li>When a message handler is provided, this method submits the <code class="docutils literal"><span class="pre">sow_delete_by_data</span></code> on a background thread,
+and calls the message handler with the results of the delete.</li>
+<li>When no message handler is provided, this method provides an acknowledgment message with the result of
+the delete command.</li>
+</ol>
+</li>
+</ul>
+<p>For example, to efficiently delete a message that your program has received from AMPS:</p>
 <div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">...</span>
 <span class="n">topic</span><span class="o">=</span> <span class="n">aMessage</span><span class="o">.</span><span class="n">get_topic</span><span class="p">()</span>
 <span class="n">data</span> <span class="o">=</span> <span class="n">aMessage</span><span class="o">.</span><span class="n">get_data</span><span class="p">()</span>
 <span class="n">ackMessage</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">sow_delete_by_data</span><span class="p">(</span><span class="n">topic</span><span class="p">,</span><span class="n">data</span><span class="p">)</span>
-<span class="nb">print</span> <span class="s2">&quot;</span><span class="si">%s</span><span class="s2">: </span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">ackMessage</span><span class="o">.</span><span class="n">get_ack_type</span><span class="p">(),</span> <span class="n">ackMessage</span><span class="o">.</span><span class="n">get_status</span><span class="p">())</span>
+<span class="nb">print</span><span class="p">(</span><span class="s2">&quot;</span><span class="si">%s</span><span class="s2">: </span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">ackMessage</span><span class="o">.</span><span class="n">get_ack_type</span><span class="p">(),</span> <span class="n">ackMessage</span><span class="o">.</span><span class="n">get_status</span><span class="p">()))</span>
 <span class="o">...</span>
 </pre></div>
 </div>
-<p>In addition to deleting a message from AMPS, this method allows deletion of
-a message whose keys match one that is already stored, for example:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">...</span>
-<span class="n">data</span> <span class="o">=</span> <span class="n">orders</span><span class="p">[</span><span class="n">orderId</span><span class="p">]</span>
+<p>In addition to deleting a message from AMPS, this method allows deletion of a message whose keys match one
+that is already stored, for example:</p>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">data</span> <span class="o">=</span> <span class="n">orders</span><span class="p">[</span><span class="n">orderId</span><span class="p">]</span>
 <span class="n">ackMessage</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">sow_delete_by_data</span><span class="p">(</span><span class="s1">&#39;orders&#39;</span><span class="p">,</span> <span class="n">data</span><span class="p">)</span>
 <span class="k">del</span> <span class="n">orders</span><span class="p">[</span><span class="n">orderId</span><span class="p">]</span>
-<span class="o">...</span>
 </pre></div>
 </div>
 <table class="docutils field-list" frame="void" rules="none">
@@ -1480,8 +1659,8 @@ a message whose keys match one that is already stored, for example:</p>
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
-<li><strong>on_message</strong> (<code class="xref py py-exc docutils literal"><span class="pre">MessageHandler</span></code>) &#8211; The message handler to invoke with <cite>stats</cite> and
-<cite>completed</cite> acknowledgments</li>
+<li><strong>on_message</strong> (<code class="xref py py-exc docutils literal"><span class="pre">MessageHandler</span></code>) &#8211; The message handler to invoke with <cite>stats</cite> and <cite>completed</cite> acknowledgments
+(specified only in the case where async processing is used).</li>
 <li><strong>topic</strong> (<em>str</em>) &#8211; The topic to execute the SOW delete against.</li>
 <li><strong>data</strong> (<em>str</em>) &#8211; A message whose keys match the message to be deleted in the server&#8217;s SOW.</li>
 <li><strong>timeout</strong> (<em>int</em>) &#8211; The maximum time to wait for the client to receive and
@@ -1490,7 +1669,8 @@ consume the processed ack for this command (in milliseconds).
 </ul>
 </td>
 </tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">The command identifier assigned to this command.</p>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">The command identifier assigned to this command if a message handler was provided.
+If no message handler was provided, returns an acknowledgment.</p>
 </td>
 </tr>
 </tbody>
@@ -1499,30 +1679,39 @@ consume the processed ack for this command (in milliseconds).
 <dl class="method">
 <dt id="AMPS.Client.sow_delete_by_keys">
-<code class="descclassname">Client.</code><code class="descname">sow_delete_by_keys</code><span class="sig-paren">(</span><em>on_message</em>, <em>topic</em>, <em>keys</em>, <em>timeout=0</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.sow_delete_by_keys" title="Permalink to this definition">¶</a></dt>
-<dd><p>Executes a SOW delete with sow keys.</p>
-<p>There are two ways to use this method. When no message handler is provided,
-the method returns a <a class="reference internal" href="#AMPS.Message" title="AMPS.Message"><code class="xref py py-class docutils literal"><span class="pre">Message</span></code></a> that will receive the results
-of the delete command.</p>
-<p>When a message handler is provided, this method submits the SOW delete on a
-background thread and calls the message handler with the results of the
-delete.</p>
+<code class="descclassname">Client.</code><code class="descname">sow_delete_by_keys</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.sow_delete_by_keys" title="Permalink to this definition">¶</a></dt>
+<dd><p><strong>Signatures</strong>:</p>
+<ul>
+<li><p class="first"><code class="docutils literal"><span class="pre">Client.sow_delete_by_keys(on_message,</span> <span class="pre">topic,</span> <span class="pre">keys,</span> <span class="pre">timeout=0)</span></code></p>
+</li>
+<li><p class="first"><code class="docutils literal"><span class="pre">Client.sow_delete_by_keys(topic,</span> <span class="pre">keys,</span> <span class="pre">timeout=0)</span></code></p>
+<p>Executes a SOW delete using the provided SOW key(s) to determine the record(s) to delete.</p>
+<p>There are two ways to use this method:</p>
+<ol class="arabic simple">
+<li>When a message handler is provided, this method submits the <code class="docutils literal"><span class="pre">sow_delete_by_keys</span></code> command on a background
+thread and calls the message handler with the results of the delete.</li>
+<li>When no message handler is provided, this method provides an acknowledgment message with the result of
+the delete command.</li>
+</ol>
+</li>
+</ul>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
-<li><strong>on_message</strong> (<code class="xref py py-exc docutils literal"><span class="pre">MessageHandler</span></code>) &#8211; The message handler to invoke with <cite>stats</cite> and
-<cite>completed</cite> acknowledgments</li>
+<li><strong>on_message</strong> (<code class="xref py py-exc docutils literal"><span class="pre">MessageHandler</span></code>) &#8211; The message handler to invoke with <cite>stats</cite> and <cite>completed</cite> acknowledgments
+(specified only in the case where async processing is used).</li>
 <li><strong>topic</strong> (<em>str</em>) &#8211; The topic to execute the SOW delete against.</li>
-<li><strong>keys</strong> (<em>str</em>) &#8211; A comma separated list of SOW keys to be deleted</li>
+<li><strong>keys</strong> (<em>str</em>) &#8211; A comma separated list of SOW keys to be deleted.</li>
 <li><strong>timeout</strong> (<em>int</em>) &#8211; The maximum time to wait for the client to receive and
 consume the processed ack for this command (in millseconds).
 <code class="docutils literal"><span class="pre">0</span></code> indicates to wait indefinitely.</li>
 </ul>
 </td>
 </tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">The command identifier assigned to this command.</p>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">The command identifier assigned to this command if a message handler was provided.
+If no message handler was provided, returns an acknowledgment.</p>
 </td>
 </tr>
 </tbody>
@@ -1532,43 +1721,70 @@ consume the processed ack for this command (in millseconds).
 <dl class="method">
 <dt id="AMPS.Client.start_timer">
 <code class="descclassname">Client.</code><code class="descname">start_timer</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.start_timer" title="Permalink to this definition">¶</a></dt>
-<dd><p>Deprecated in version 5.3.2.0. Used to start a timer on an AMPS Server for the client.</p>
+<dd><p>Used to start a timer on an AMPS Server for the client.</p>
+<div class="deprecated">
+<p><span class="versionmodified">Deprecated since version 5.3.2.0.</span></p>
+</div>
 </dd></dl>
 <dl class="method">
 <dt id="AMPS.Client.stop_timer">
 <code class="descclassname">Client.</code><code class="descname">stop_timer</code><span class="sig-paren">(</span><em>handler</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.stop_timer" title="Permalink to this definition">¶</a></dt>
-<dd><p>Deprecated in version 5.3.2.0. Used to stop a timer on an AMPS Server previously started for the client.
-:param handler: The handler to be invoked with the timer response.</p>
+<dd><p>Used to stop a timer on an AMPS Server previously started for the client.</p>
+<div class="deprecated">
+<p><span class="versionmodified">Deprecated since version 5.3.2.0.</span></p>
+</div>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>handler</strong> &#8211; The handler to be invoked with the timer response.</td>
+</tr>
+</tbody>
+</table>
 </dd></dl>
 <dl class="method">
 <dt id="AMPS.Client.subscribe">
-<code class="descclassname">Client.</code><code class="descname">subscribe</code><span class="sig-paren">(</span><em>on_message</em>, <em>topic</em>, <em>filter=None</em>, <em>options=None</em>, <em>timeout=0</em>, <em>sub_id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.subscribe" title="Permalink to this definition">¶</a></dt>
-<dd><p>Places a subscription with AMPS.</p>
+<code class="descclassname">Client.</code><code class="descname">subscribe</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.subscribe" title="Permalink to this definition">¶</a></dt>
+<dd><p><strong>Signatures</strong>:</p>
+<ul>
+<li><p class="first"><code class="docutils literal"><span class="pre">Client.subscribe(on_message,</span> <span class="pre">topic,</span> <span class="pre">filter=None,</span> <span class="pre">options=None,</span> <span class="pre">timeout=0,</span> <span class="pre">sub_id=None)</span></code></p>
+</li>
+<li><p class="first"><code class="docutils literal"><span class="pre">Client.subscribe(topic,</span> <span class="pre">filter=None,</span> <span class="pre">options=None,</span> <span class="pre">timeout=0,</span> <span class="pre">sub_id=None)</span></code></p>
+<p>Places a subscription with AMPS.</p>
+<p>There are two ways to use this method:</p>
+<ol class="arabic simple">
+<li>When a message handler is provided, this method submits the <code class="docutils literal"><span class="pre">subscribe</span></code> command on a background thread and
+calls the message handler with individual messages that match the subscription.</li>
+<li>When no message handler is provided, this method returns a message stream that can be iterated on to process
+messages received that match the subscription.</li>
+</ol>
+</li>
+</ul>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
 <li><strong>on_message</strong> (<em>str</em>) &#8211; The message handler to invoke with matching
-messages.</li>
+messages (specified only in the case where async processing is used).</li>
 <li><strong>topic</strong> (<em>str</em>) &#8211; The topic to subscribe to.</li>
 <li><strong>filter</strong> (<em>str</em>) &#8211; The filter.</li>
-<li><strong>options</strong> (<em>str</em>) &#8211; A comma separated list of values indicating additional
-processing options.</li>
-<li><strong>timeout</strong> (<em>int</em>) &#8211; The maximum time to wait for the client to receive and
+<li><strong>options</strong> (<em>str</em>) &#8211; A comma separated list of values indicating additional processing options.</li>
+<li><strong>timeout</strong> (<em>int</em>) &#8211; The maximum time to wait for the client to receive and
 consume the processed ack for this command (in milliseconds).
 <code class="docutils literal"><span class="pre">0</span></code> indicates to wait indefinitely.</li>
-<li><strong>sub_id</strong> (<em>str</em>) &#8211; The subscription ID.  You may optionally provide a
+<li><strong>sub_id</strong> (<em>str</em>) &#8211; The subscription ID. You may optionally provide a
 subscription ID to ease recovery scenarios, instead of having the
-system automatically generate one for you.
-When used with the &#8216;replace&#8217; option, this is the subscription to
-be replaced.</li>
+system automatically generate one for you. When used with the &#8216;replace&#8217; option,
+this is the subscription to be replaced.</li>
 </ul>
 </td>
 </tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The command identifier assigned to this command.</p>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The command identifier assigned to this command if a message handler was provided.
+If no message handler was provided, returns a <code class="docutils literal"><span class="pre">MessageStream</span></code> containing the results
+of the command.</p>
 </td>
 </tr>
 <tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last"><a class="reference internal" href="#AMPS.SubscriptionAlreadyExistsException" title="AMPS.SubscriptionAlreadyExistsException"><code class="xref py py-exc docutils literal"><span class="pre">SubscriptionAlreadyExistsException</span></code></a>,
@@ -1583,13 +1799,18 @@ be replaced.</li>
 <dl class="method">
 <dt id="AMPS.Client.unsubscribe">
 <code class="descclassname">Client.</code><code class="descname">unsubscribe</code><span class="sig-paren">(</span><em>sub_id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Client.unsubscribe" title="Permalink to this definition">¶</a></dt>
-<dd><blockquote>
-<div>Remove a subscription from AMPS.</div></blockquote>
+<dd><p>Remove a subscription from AMPS.</p>
+<blockquote>
+<div><div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p class="last">Using the keyword <code class="docutils literal"><span class="pre">all</span></code> with <code class="docutils literal"><span class="pre">sub_id</span></code> will remove all subscriptions to AMPS.</p>
+</div>
+</div></blockquote>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>sub_id</strong> &#8211; The subscription id to remove.</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>sub_id</strong> (<em>str</em>) &#8211; The subscription ID to remove.</td>
 </tr>
 </tbody>
 </table>
@@ -1606,9 +1827,9 @@ be replaced.</li>
 <dl class="class">
 <dt id="AMPS.Command">
-<em class="property">class </em><code class="descclassname">AMPS.</code><code class="descname">Command</code><a class="headerlink" href="#AMPS.Command" title="Permalink to this definition">¶</a></dt>
+<em class="property">class </em><code class="descclassname">AMPS.</code><code class="descname">Command</code><span class="sig-paren">(</span><em>command_name</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Command" title="Permalink to this definition">¶</a></dt>
 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
-<p>AMPS.Command represents a single message (or <em>command</em>) sent to the
+<p><code class="docutils literal"><span class="pre">AMPS.Command</span></code> represents a single message (or <em>command</em>) sent to the
 AMPS server. The class provides methods for headers that are used
 for commands to the server. Applications typically use this class
 to create outgoing requests to AMPS. The responses to requests,
@@ -1625,6 +1846,16 @@ Command, set options as described in the Command Cookbook in the
 Python Developer Guide or the AMPS Command Reference, and then use
 <a class="reference internal" href="#AMPS.Client.execute_async" title="AMPS.Client.execute_async"><code class="xref py py-func docutils literal"><span class="pre">AMPS.Client.execute_async()</span></code></a> to process messages asynchronously,
 or <a class="reference internal" href="#AMPS.Client.execute" title="AMPS.Client.execute"><code class="xref py py-func docutils literal"><span class="pre">AMPS.Client.execute()</span></code></a> to process messages synchronously.</p>
+<p><strong>Constructor Arguments:</strong></p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>command_name</strong> &#8211; The name of the command to send to the server.
+For example, <code class="docutils literal"><span class="pre">sow</span></code>, <code class="docutils literal"><span class="pre">sow_and_subscribe</span></code> or <code class="docutils literal"><span class="pre">publish</span></code>.</td>
+</tr>
+</tbody>
+</table>
 <dl class="method">
 <dt id="AMPS.Command.add_ack_type">
 <code class="descname">add_ack_type</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.Command.add_ack_type" title="Permalink to this definition">¶</a></dt>
@@ -1676,6 +1907,14 @@ that have been previously set or that will be set by the Client.</p>
 <dd><p>Gets the sequence of self for <code class="docutils literal"><span class="pre">publish</span></code>, <code class="docutils literal"><span class="pre">delta_publish</span></code>, or <code class="docutils literal"><span class="pre">sow_delete</span></code> commands.
 This can be checked after calling <code class="docutils literal"><span class="pre">execute</span></code> or <code class="docutils literal"><span class="pre">executeAsync</span></code> to query the sequence
 number that was used, if any.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The sequence number used in the last <code class="docutils literal"><span class="pre">publish</span></code>, <code class="docutils literal"><span class="pre">delta_publish</span></code>, or <code class="docutils literal"><span class="pre">sow_delete</span></code> command.</td>
+</tr>
+</tbody>
+</table>
 </dd></dl>
 <dl class="method">
@@ -1751,7 +1990,7 @@ details on SOW query batches.</p>
 <dd><p>Sets the value of the bookmark header. For a subscription, this identifies the point in the
 transaction log at which to begin the replay. For a <code class="docutils literal"><span class="pre">sow_delete</span></code> (queue acknowledgment), this
 indicates the message or messages to acknowledge. For a query on a SOW topic with
-History configured, this indicates the point at which to query the topic.</p>
+<code class="docutils literal"><span class="pre">History</span></code> configured, this indicates the point at which to query the topic.</p>
 <p>Not all headers are processed by AMPS for all commands. See the AMPS Command Reference for which headers are used by AMPS for a specific command.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
@@ -2293,20 +2532,19 @@ If no sub_id is provided, remove all records for this client.
 <dt id="AMPS.DefaultServerChooser">
 <em class="property">class </em><code class="descclassname">AMPS.</code><code class="descname">DefaultServerChooser</code><a class="headerlink" href="#AMPS.DefaultServerChooser" title="Permalink to this definition">¶</a></dt>
 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
-<p>A simple ServerChooser that keeps a list of AMPS instances and
+<p>A simple server chooser that keeps a list of AMPS instances and
 Authenticators, and advances to the next one when failure occurs.</p>
 <p>To use the <code class="docutils literal"><span class="pre">DefaultServerChooser</span></code>, you add the URIs for the server to
-choose from, then set the server for the HAClient as shown below:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span>      <span class="n">client</span> <span class="o">=</span> <span class="n">AMPS</span><span class="o">.</span><span class="n">HAClient</span><span class="p">(</span><span class="s2">&quot;showchooser&quot;</span><span class="p">)</span>
-      <span class="n">chooser</span> <span class="o">=</span> <span class="n">AMPS</span><span class="o">.</span><span class="n">DefaultServerChooser</span><span class="p">()</span>
-      <span class="n">chooser</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="s2">&quot;tcp://server:9005/nvfix&quot;</span><span class="p">)</span>
-      <span class="n">chooser</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="s2">&quot;tcp://server-two:9005/nvfix&quot;</span><span class="p">)</span>
-      <span class="n">client</span><span class="o">.</span><span class="n">set_server_chooser</span><span class="p">(</span><span class="n">chooser</span><span class="p">)</span>
-      <span class="n">client</span><span class="o">.</span><span class="n">connect_and_logon</span><span class="p">()</span>
-<span class="n">You</span> <span class="n">can</span> <span class="n">add</span> <span class="nb">any</span> <span class="n">number</span> <span class="n">of</span> <span class="n">URIs</span> <span class="n">to</span> <span class="n">the</span> <span class="n">DefaultServerChooser</span><span class="o">.</span>
+choose from, then set the server for the <code class="docutils literal"><span class="pre">HAClient</span></code> as shown below:</p>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">client</span> <span class="o">=</span> <span class="n">AMPS</span><span class="o">.</span><span class="n">HAClient</span><span class="p">(</span><span class="s2">&quot;showchooser&quot;</span><span class="p">)</span>
+<span class="n">chooser</span> <span class="o">=</span> <span class="n">AMPS</span><span class="o">.</span><span class="n">DefaultServerChooser</span><span class="p">()</span>
+<span class="n">chooser</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="s2">&quot;tcp://server:9005/nvfix&quot;</span><span class="p">)</span>
+<span class="n">chooser</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="s2">&quot;tcp://server-two:9005/nvfix&quot;</span><span class="p">)</span>
+<span class="n">client</span><span class="o">.</span><span class="n">set_server_chooser</span><span class="p">(</span><span class="n">chooser</span><span class="p">)</span>
+<span class="n">client</span><span class="o">.</span><span class="n">connect_and_logon</span><span class="p">()</span>
 </pre></div>
 </div>
+<p>You can add any number of URIs to the <code class="docutils literal"><span class="pre">DefaultServerChooser</span></code>.</p>
 <dl class="method">
 <dt id="AMPS.DefaultServerChooser.add">
 <code class="descname">add</code><span class="sig-paren">(</span><em>uri</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.DefaultServerChooser.add" title="Permalink to this definition">¶</a></dt>
@@ -2440,40 +2678,31 @@ choose from, then set the server for the HAClient as shown below:</p>
 <dl class="class">
 <dt id="AMPS.ExponentialDelayStrategy">
-<em class="property">class </em><code class="descclassname">AMPS.</code><code class="descname">ExponentialDelayStrategy</code><a class="headerlink" href="#AMPS.ExponentialDelayStrategy" title="Permalink to this definition">¶</a></dt>
+<em class="property">class </em><code class="descclassname">AMPS.</code><code class="descname">ExponentialDelayStrategy</code><span class="sig-paren">(</span><em>initial_delay=200</em>, <em>maximum_delay=20000</em>, <em>backoff_exponent=2.0</em>, <em>maximum_retry_time=0</em>, <em>jitter=1.0</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.ExponentialDelayStrategy" title="Permalink to this definition">¶</a></dt>
 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
-<p>ExponentialDelayStrategy is an implementation that exponentially
-backs off when reconnecting to the same server, with a maximum
-time to retry before it gives up entirely.</p>
-<p>By default, an ExponentialDelayStrategy has an initial delay of
-200 ms, a maximum delay of  20 seconds, a backoff exponent of
-2.0, and has no limit to the amount of time to retry the connection.</p>
-<p>Constructor parameters:</p>
+<p><code class="docutils literal"><span class="pre">ExponentialDelayStrategy</span></code> is an implementation that exponentially backs off when reconnecting to
+the same server, with a maximum time to retry before it gives up entirely.</p>
+<p>By default, an <code class="docutils literal"><span class="pre">ExponentialDelayStrategy</span></code> has an initial delay of 200 ms, a maximum delay of 20 seconds,
+a backoff exponent of 2.0, and has no limit to the amount of time to retry the connection.</p>
+<p><strong>Constructor Arguments:</strong></p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
-<li><strong>initial_delay</strong> &#8211; The time (in milliseconds) to wait before
-reconnecting to a server for the first
+<li><strong>initial_delay</strong> &#8211; The time (in milliseconds) to wait before reconnecting to a server for the first
 time after a failed connection.</li>
-<li><strong>maximum_delay</strong> &#8211; The maximum time to wait for any reconnect
-attempt (milliseconds). Exponential
-backoff will not exceed this maximum.</li>
-<li><strong>backoff_exponent</strong> &#8211; The exponent to use for calculating the
-next delay time. For example, if the
-initial time is 200ms and the exponent
-is 2.0, the next delay will be 400ms,
+<li><strong>maximum_delay</strong> &#8211; The maximum time to wait for any reconnect attempt (milliseconds).
+Exponential backoff will not exceed this maximum.</li>
+<li><strong>backoff_exponent</strong> &#8211; The exponent to use for calculating the next delay time. For example, if the
+initial time is 200ms and the exponent is 2.0, the next delay will be 400ms,
 then 800ms, etc.</li>
-<li><strong>maximum_retry_time</strong> &#8211; The maximum time (milliseconds) to allow
-reconnect attempts to continue without
-a successful connection, before &#8220;giving
-up&#8221; and abandoning the connection attempt.</li>
-<li><strong>jitter</strong> &#8211; The amount of &#8216;jitter&#8217; to apply when
-calculating a delay time, measured in multiples
-of the initial delay. Jitter is used to reduce
-the number of simultaneous reconnects that may
-be issued from multiple clients.</li>
+<li><strong>maximum_retry_time</strong> &#8211; The maximum time (milliseconds) to allow reconnect attempts to continue
+without a successful connection, before &#8216;giving up&#8217; and abandoning the
+connection attempt.</li>
+<li><strong>jitter</strong> &#8211; The amount of &#8216;jitter&#8217; to apply when calculating a delay time, measured in multiples
+of the initial delay. Jitter is used to reduce the number of simultaneous reconnects
+that may be issued from multiple clients.</li>
 </ul>
 </td>
 </tr>
@@ -2565,23 +2794,21 @@ be issued from multiple clients.</li>
 <dl class="class">
 <dt id="AMPS.FixedDelayStrategy">
-<em class="property">class </em><code class="descclassname">AMPS.</code><code class="descname">FixedDelayStrategy</code><a class="headerlink" href="#AMPS.FixedDelayStrategy" title="Permalink to this definition">¶</a></dt>
+<em class="property">class </em><code class="descclassname">AMPS.</code><code class="descname">FixedDelayStrategy</code><span class="sig-paren">(</span><em>initial_delay</em>, <em>maximum</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.FixedDelayStrategy" title="Permalink to this definition">¶</a></dt>
 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
-<p>FixedDelayStrategy is a reconnect delay strategy implementation that
-waits a fixed amount of time before retrying a connection.</p>
-<p>By default, a FixedDelayStrategy waits for 200ms between connection attempts
+<p><code class="docutils literal"><span class="pre">FixedDelayStrategy</span></code> is a reconnect delay strategy implementation that waits a
+fixed amount of time before retrying a connection.</p>
+<p>By default, a <code class="docutils literal"><span class="pre">FixedDelayStrategy</span></code> waits for 200ms between connection attempts
 and does not have a maximum timeout.</p>
-<p>Constructor parameters:</p>
+<p><strong>Constructor Arguments:</strong></p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
-<li><strong>initial_delay</strong> &#8211; The time (in milliseconds) to wait before
-reconnecting to a server for the first
-time after a failed connection.</li>
-<li><strong>maximum</strong> &#8211; The maximum time (in milliseconds) to keep
-retrying before giving up.</li>
+<li><strong>initial_delay</strong> &#8211; The time (in milliseconds) to wait before reconnecting to a
+server for the first time after a failed connection.</li>
+<li><strong>maximum</strong> &#8211; The maximum time (in milliseconds) to keep retrying before giving up.</li>
 </ul>
 </td>
 </tr>
@@ -2603,10 +2830,24 @@ retrying before giving up.</li>
 <dl class="class">
 <dt id="AMPS.HAClient">
-<em class="property">class </em><code class="descclassname">AMPS.</code><code class="descname">HAClient</code><a class="headerlink" href="#AMPS.HAClient" title="Permalink to this definition">¶</a></dt>
+<em class="property">class </em><code class="descclassname">AMPS.</code><code class="descname">HAClient</code><span class="sig-paren">(</span><em>name</em>, <em>publish_store=None</em>, <em>bookmark_store=None</em>, <em>no_store=False</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.HAClient" title="Permalink to this definition">¶</a></dt>
 <dd><p>Bases: <a class="reference internal" href="#AMPS.Client" title="AMPS.Client"><code class="xref py py-class docutils literal"><span class="pre">AMPS.Client</span></code></a></p>
-<p>AMPS HAClient Object used for highly-available client connections. Derives from <a class="reference internal" href="#AMPS.Client" title="AMPS.Client"><code class="xref py py-class docutils literal"><span class="pre">Client</span></code></a>.</p>
-<p>Constructor arguments:</p>
+<p>AMPS <code class="docutils literal"><span class="pre">HAClient</span></code> Object used for highly-available client connections. Derives from <a class="reference internal" href="#AMPS.Client" title="AMPS.Client"><code class="xref py py-class docutils literal"><span class="pre">Client</span></code></a>.</p>
+<p>An example of a Python client publishing a JSON message using the <code class="docutils literal"><span class="pre">HAClient</span></code> is listed below:</p>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">client</span> <span class="o">=</span> <span class="n">AMPS</span><span class="o">.</span><span class="n">HAClient</span><span class="p">(</span><span class="s2">&quot;test_client&quot;</span><span class="p">)</span>
+<span class="n">chooser</span> <span class="o">=</span> <span class="n">AMPS</span><span class="o">.</span><span class="n">DefaultServerChooser</span><span class="p">()</span>
+<span class="n">chooser</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="s2">&quot;tcp://127.0.0.1:9004/amps/json&quot;</span><span class="p">)</span>
+<span class="n">client</span><span class="o">.</span><span class="n">set_server_chooser</span><span class="p">(</span><span class="n">chooser</span><span class="p">)</span>
+<span class="k">try</span><span class="p">:</span>
+  <span class="n">client</span><span class="o">.</span><span class="n">connect_and_logon</span><span class="p">()</span>
+  <span class="n">client</span><span class="o">.</span><span class="n">publish</span><span class="p">(</span><span class="s2">&quot;topic_name&quot;</span><span class="p">,</span><span class="s1">&#39;{&quot;a&quot;:1,&quot;b&quot;:&quot;2&quot;}&#39;</span><span class="p">)</span>
+<span class="k">finally</span><span class="p">:</span>
+  <span class="n">client</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
+</pre></div>
+</div>
+<p><strong>Constructor Arguments:</strong></p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
@@ -2628,7 +2869,7 @@ using control characters, newline characters, or square brackets.</li>
 <dl class="method">
 <dt id="AMPS.HAClient.connect">
 <code class="descname">connect</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.HAClient.connect" title="Permalink to this definition">¶</a></dt>
-<dd><p>Connects and logs on using the ServerChooser you&#8217;ve supplied via <a class="reference internal" href="#AMPS.HAClient.set_server_chooser" title="AMPS.HAClient.set_server_chooser"><code class="xref py py-meth docutils literal"><span class="pre">set_server_chooser()</span></code></a>. Will continue
+<dd><p>Connects and logs on using the <code class="docutils literal"><span class="pre">ServerChooser</span></code> you&#8217;ve supplied via <a class="reference internal" href="#AMPS.HAClient.set_server_chooser" title="AMPS.HAClient.set_server_chooser"><code class="xref py py-meth docutils literal"><span class="pre">set_server_chooser()</span></code></a>. Will continue
 attempting to connect and logon to each URI returned by the <code class="docutils literal"><span class="pre">ServerChooser</span></code> until the connection succeeds or
 the <code class="docutils literal"><span class="pre">ServerChooser</span></code> returns an empty URI.</p>
 </dd></dl>
@@ -2636,7 +2877,7 @@ the <code class="docutils literal"><span class="pre">ServerChooser</span></code>
 <dl class="method">
 <dt id="AMPS.HAClient.connect_and_logon">
 <code class="descname">connect_and_logon</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.HAClient.connect_and_logon" title="Permalink to this definition">¶</a></dt>
-<dd><p>Connects and logs on using the ServerChooser you&#8217;ve supplied via <a class="reference internal" href="#AMPS.HAClient.set_server_chooser" title="AMPS.HAClient.set_server_chooser"><code class="xref py py-meth docutils literal"><span class="pre">set_server_chooser()</span></code></a>. Will continue
+<dd><p>Connects and logs on using the <code class="docutils literal"><span class="pre">ServerChooser</span></code> you&#8217;ve supplied via <a class="reference internal" href="#AMPS.HAClient.set_server_chooser" title="AMPS.HAClient.set_server_chooser"><code class="xref py py-meth docutils literal"><span class="pre">set_server_chooser()</span></code></a>. Will continue
 attempting to connect and logon to each URI returned by the <code class="docutils literal"><span class="pre">ServerChooser</span></code> until the connection succeeds or
 the <code class="docutils literal"><span class="pre">ServerChooser</span></code> returns an empty URI.</p>
 </dd></dl>
@@ -2713,7 +2954,7 @@ subscription after a re-connect.</p>
 <dl class="method">
 <dt id="AMPS.HAClient.logon">
 <code class="descname">logon</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.HAClient.logon" title="Permalink to this definition">¶</a></dt>
-<dd><p>Not used in the HAClient; call <a class="reference internal" href="#AMPS.HAClient.connect_and_logon" title="AMPS.HAClient.connect_and_logon"><code class="xref py py-meth docutils literal"><span class="pre">connect_and_logon()</span></code></a> to connect and log on to AMPS once a server chooser is set.</p>
+<dd><p>Not used in the <code class="docutils literal"><span class="pre">HAClient</span></code>; call <a class="reference internal" href="#AMPS.HAClient.connect_and_logon" title="AMPS.HAClient.connect_and_logon"><code class="xref py py-meth docutils literal"><span class="pre">connect_and_logon()</span></code></a> to connect and log on to AMPS once a server chooser is set.</p>
 </dd></dl>
 <dl class="method">
@@ -2771,7 +3012,7 @@ remove the subscription from the subscription manager.</p>
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>options</strong> (<em>string</em>) &#8211; An options string to be passed to the server during logon, such as <code class="docutils literal"><span class="pre">ack_conflation=100us</span></code>.</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>options</strong> (<em>string</em>) &#8211; An options string to be passed to the server during logon, such as <code class="docutils literal"><span class="pre">ack_conflation=100ms</span></code>.</td>
 </tr>
 </tbody>
 </table>
@@ -2779,15 +3020,15 @@ remove the subscription from the subscription manager.</p>
 <dl class="method">
 <dt id="AMPS.HAClient.set_reconnect_delay">
-<code class="descname">set_reconnect_delay</code><span class="sig-paren">(</span><em>reconnectDelay</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.HAClient.set_reconnect_delay" title="Permalink to this definition">¶</a></dt>
+<code class="descname">set_reconnect_delay</code><span class="sig-paren">(</span><em>reconnect_delay</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.HAClient.set_reconnect_delay" title="Permalink to this definition">¶</a></dt>
 <dd><p>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 <a class="reference internal" href="#AMPS.FixedDelayStrategy" title="AMPS.FixedDelayStrategy"><code class="xref py py-class docutils literal"><span class="pre">FixedDelayStrategy</span></code></a> in this client.
 Default value is 200 (0.2 seconds).</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>reconnectDelay</strong> &#8211; The number of milliseconds to wait before reconnecting, after a disconnect occurs.</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>reconnect_delay</strong> &#8211; The number of milliseconds to wait before reconnecting, after a disconnect occurs.</td>
 </tr>
 </tbody>
 </table>
@@ -2795,23 +3036,23 @@ Default value is 200 (0.2 seconds).</p>
 <dl class="method">
 <dt id="AMPS.HAClient.set_reconnect_delay_strategy">
-<code class="descname">set_reconnect_delay_strategy</code><span class="sig-paren">(</span><em>reconnectDelayStrategy</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.HAClient.set_reconnect_delay_strategy" title="Permalink to this definition">¶</a></dt>
+<code class="descname">set_reconnect_delay_strategy</code><span class="sig-paren">(</span><em>reconnect_delay_strategy</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.HAClient.set_reconnect_delay_strategy" title="Permalink to this definition">¶</a></dt>
 <dd><p>Sets the reconnect delay strategy object used to control delay behavior
 when connecting and reconnecting to servers.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>strategy</strong> &#8211; <p>The reconnect delay strategy object to use when connecting
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>reconnect_delay_strategy</strong> &#8211; <p>The reconnect delay strategy object to use when connecting
 and reconnecting to AMPS instances. The object must have
 the following two methods defined:</p>
 <blockquote>
 <div><dl class="docutils">
-<dt>get_connect_wait_duration(uri):</dt>
+<dt><code class="docutils literal"><span class="pre">get_connect_wait_duration(uri)</span></code>:</dt>
 <dd><em>uri</em> - A string containing the next URI AMPS will connect with.
 <em>Returns</em> an integer representing the time in milliseconds to wait
 before connecting to that URI.</dd>
-<dt>reset():</dt>
+<dt><code class="docutils literal"><span class="pre">reset()</span></code>:</dt>
 <dd>Resets the state of self after a successful connection.</dd>
 </dl>
 </div></blockquote>
@@ -2860,7 +3101,7 @@ Default value is 10000 (10 seconds).</p>
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>timeout</strong> &#8211; The number of milliseconds to wait for a server response to logon. 0 indicates no timeout.</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>timeout</strong> &#8211; The number of milliseconds to wait for a server response to logon. <code class="docutils literal"><span class="pre">0</span></code> indicates no timeout.</td>
 </tr>
 </tbody>
 </table>
@@ -2873,18 +3114,73 @@ Default value is 10000 (10 seconds).</p>
 <em class="property">class </em><code class="descclassname">AMPS.</code><code class="descname">HybridPublishStore</code><a class="headerlink" href="#AMPS.HybridPublishStore" title="Permalink to this definition">¶</a></dt>
 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
 <p>A publish store that keeps messages on disk as well as in memory. When used with an HAClient, the HAClient manages storing messages in the publish store, replaying messages to the server after failover, and removing messages from the store.  With this publish store, an application can recover messages from disk after exiting and restarting.</p>
+<dl class="method">
+<dt id="AMPS.HybridPublishStore.discard_up_to">
+<code class="descname">discard_up_to</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.HybridPublishStore.discard_up_to" title="Permalink to this definition">¶</a></dt>
+<dd><p>Discard all messages in the publish store with a sequence number less than or equal to the provided argument.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>sequence</strong> &#8211; The highest sequence number to discard.</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+<dl class="method">
+<dt id="AMPS.HybridPublishStore.get_last_persisted">
+<code class="descname">get_last_persisted</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.HybridPublishStore.get_last_persisted" title="Permalink to this definition">¶</a></dt>
+<dd><p>Returns the sequence number of last message ACK&#8217;ed by the server.</p>
+</dd></dl>
+<dl class="method">
+<dt id="AMPS.HybridPublishStore.get_lowest_unpersisted">
+<code class="descname">get_lowest_unpersisted</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.HybridPublishStore.get_lowest_unpersisted" title="Permalink to this definition">¶</a></dt>
+<dd><p>Returns the sequence number of the oldest message in the publish store.</p>
+</dd></dl>
 <dl class="method">
 <dt id="AMPS.HybridPublishStore.get_unpersisted_count">
 <code class="descname">get_unpersisted_count</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.HybridPublishStore.get_unpersisted_count" title="Permalink to this definition">¶</a></dt>
 <dd><p>Returns the number of messages published which have not been ACK&#8217;ed by the server.</p>
 </dd></dl>
+<dl class="method">
+<dt id="AMPS.HybridPublishStore.replay">
+<code class="descname">replay</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.HybridPublishStore.replay" title="Permalink to this definition">¶</a></dt>
+<dd><p>Replays all messages currently in the publish store via the provided message handler.
+:param handler: The message handler to call with each message.</p>
+</dd></dl>
+<dl class="method">
+<dt id="AMPS.HybridPublishStore.replay_single">
+<code class="descname">replay_single</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.HybridPublishStore.replay_single" title="Permalink to this definition">¶</a></dt>
+<dd><p>Replays the message with the given sequence number if it is currently in the publish store via the provided message handler.
+:param handler: The message handler to call with each message.
+:param sequence: The sequence number of the message to replay.</p>
+</dd></dl>
 <dl class="method">
 <dt id="AMPS.HybridPublishStore.set_resize_handler">
 <code class="descname">set_resize_handler</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.HybridPublishStore.set_resize_handler" title="Permalink to this definition">¶</a></dt>
 <dd><p>Sets the object to call when the store needs to resize.</p>
 </dd></dl>
+<dl class="method">
+<dt id="AMPS.HybridPublishStore.store">
+<code class="descname">store</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.HybridPublishStore.store" title="Permalink to this definition">¶</a></dt>
+<dd><p>Store the provided message into the publish store. Returns the sequence number that should be assigned to the message.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>message</strong> &#8211; The message to put into the store.</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
 </dd></dl>
 <dl class="exception">
@@ -3182,6 +3478,20 @@ deal with persisted acks and calls to get_most_recent().</p>
 <em class="property">class </em><code class="descclassname">AMPS.</code><code class="descname">MemoryPublishStore</code><a class="headerlink" href="#AMPS.MemoryPublishStore" title="Permalink to this definition">¶</a></dt>
 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
 <p>A publish store that keeps messages in memory. This class is the default publish store for a python HAClient. The HAClient manages storing messages in the publish store, replaying messages to the server after failover, and removing messages from the store.  With this publish store, an application typically checks to be sure that the publish store is empty (that is, all messages have been persisted in the AMPS server) before exiting.</p>
+<dl class="method">
+<dt id="AMPS.MemoryPublishStore.discard_up_to">
+<code class="descname">discard_up_to</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.MemoryPublishStore.discard_up_to" title="Permalink to this definition">¶</a></dt>
+<dd><p>Discard all messages in the publish store with a sequence number less than or equal to the provided argument.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>sequence</strong> &#8211; The highest sequence number to discard.</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
 <dl class="method">
 <dt id="AMPS.MemoryPublishStore.get_error_on_publish_gap">
 <code class="descname">get_error_on_publish_gap</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.MemoryPublishStore.get_error_on_publish_gap" title="Permalink to this definition">¶</a></dt>
@@ -3192,12 +3502,39 @@ appears to be missing messages no longer held in the store.</dd>
 </dl>
 </dd></dl>
+<dl class="method">
+<dt id="AMPS.MemoryPublishStore.get_last_persisted">
+<code class="descname">get_last_persisted</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.MemoryPublishStore.get_last_persisted" title="Permalink to this definition">¶</a></dt>
+<dd><p>Returns the sequence number of last message ACK&#8217;ed by the server.</p>
+</dd></dl>
+<dl class="method">
+<dt id="AMPS.MemoryPublishStore.get_lowest_unpersisted">
+<code class="descname">get_lowest_unpersisted</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.MemoryPublishStore.get_lowest_unpersisted" title="Permalink to this definition">¶</a></dt>
+<dd><p>Returns the sequence number of the oldest message in the publish store.</p>
+</dd></dl>
 <dl class="method">
 <dt id="AMPS.MemoryPublishStore.get_unpersisted_count">
 <code class="descname">get_unpersisted_count</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.MemoryPublishStore.get_unpersisted_count" title="Permalink to this definition">¶</a></dt>
 <dd><p>Returns the number of messages published which have not been ACK&#8217;ed by the server.</p>
 </dd></dl>
+<dl class="method">
+<dt id="AMPS.MemoryPublishStore.replay">
+<code class="descname">replay</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.MemoryPublishStore.replay" title="Permalink to this definition">¶</a></dt>
+<dd><p>Replays all messages currently in the publish store via the provided message handler.
+:param handler: The message handler to call with each message.</p>
+</dd></dl>
+<dl class="method">
+<dt id="AMPS.MemoryPublishStore.replay_single">
+<code class="descname">replay_single</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.MemoryPublishStore.replay_single" title="Permalink to this definition">¶</a></dt>
+<dd><p>Replays the message with the given sequence number if it is currently in the publish store via the provided message handler.
+:param handler: The message handler to call with each message.
+:param sequence: The sequence number of the message to replay.</p>
+</dd></dl>
 <dl class="method">
 <dt id="AMPS.MemoryPublishStore.set_error_on_publish_gap">
 <code class="descname">set_error_on_publish_gap</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.MemoryPublishStore.set_error_on_publish_gap" title="Permalink to this definition">¶</a></dt>
@@ -3220,6 +3557,20 @@ appears to be missing messages no longer held in the store.</td>
 <dd><p>Sets the object to call when the store needs to resize.</p>
 </dd></dl>
+<dl class="method">
+<dt id="AMPS.MemoryPublishStore.store">
+<code class="descname">store</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.MemoryPublishStore.store" title="Permalink to this definition">¶</a></dt>
+<dd><p>Store the provided message into the publish store. Returns the sequence number that should be assigned to the message.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>message</strong> &#8211; The message to put into the store.</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
 </dd></dl>
 <dl class="class">
@@ -5992,31 +6343,31 @@ stream remains open.</div></blockquote>
 <dl class="class">
 <dt id="AMPS.NVFIXBuilder">
-<em class="property">class </em><code class="descclassname">AMPS.</code><code class="descname">NVFIXBuilder</code><a class="headerlink" href="#AMPS.NVFIXBuilder" title="Permalink to this definition">¶</a></dt>
+<em class="property">class </em><code class="descclassname">AMPS.</code><code class="descname">NVFIXBuilder</code><span class="sig-paren">(</span><em>delimiter</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.NVFIXBuilder" title="Permalink to this definition">¶</a></dt>
 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
 <p>Convenience class for easily creating NVFIX strings.</p>
-<p>Constructor arguments:</p>
+<p><strong>Constructor Arguments:</strong></p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>delimiter</strong> &#8211; The delimiter to use between NVFIX fields. Defaults to \\x01 if no delimiter is provided.</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>delimiter</strong> &#8211; The delimiter to use between NVFIX fields. Defaults to \x01 if no delimiter is provided.</td>
 </tr>
 </tbody>
 </table>
 <dl class="method">
 <dt id="AMPS.NVFIXBuilder.append">
-<code class="descname">append</code><span class="sig-paren">(</span><em>tag</em>, <em>value</em>, <em>(optional)offset</em>, <em>(optional)length</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.NVFIXBuilder.append" title="Permalink to this definition">¶</a></dt>
-<dd><p>Appends tag=value to self.</p>
+<code class="descname">append</code><span class="sig-paren">(</span><em>tag</em>, <em>value</em>, <em>offset(optional)</em>, <em>length(optional)</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.NVFIXBuilder.append" title="Permalink to this definition">¶</a></dt>
+<dd><p>Appends <code class="docutils literal"><span class="pre">tag=value</span></code> to self.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
-<li><strong>tag</strong> (<em>int</em>) &#8211; The tag to use.</li>
+<li><strong>tag</strong> (<em>str</em>) &#8211; The tag to use.</li>
 <li><strong>value</strong> (<em>str</em>) &#8211; The value for the given tag.</li>
-<li><strong>offset</strong> (<em>int</em>) &#8211; Optional. The offset into value at which the value actually starts.</li>
-<li><strong>length</strong> &#8211; Optional. The length of the actual value within value. Only valid and required if offset is also provided.</li>
+<li><strong>offset</strong> (<em>int</em>) &#8211; The offset into value at which the value actually starts. <em>Optional.</em></li>
+<li><strong>length</strong> (<em>int</em>) &#8211; The length of the actual value within value. <em>Optional.</em> Only valid and required if offset is also provided.</li>
 </ul>
 </td>
 </tr>
@@ -6048,15 +6399,15 @@ stream remains open.</div></blockquote>
 <dl class="class">
 <dt id="AMPS.NVFIXShredder">
-<em class="property">class </em><code class="descclassname">AMPS.</code><code class="descname">NVFIXShredder</code><a class="headerlink" href="#AMPS.NVFIXShredder" title="Permalink to this definition">¶</a></dt>
+<em class="property">class </em><code class="descclassname">AMPS.</code><code class="descname">NVFIXShredder</code><span class="sig-paren">(</span><em>delimiter</em><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.NVFIXShredder" title="Permalink to this definition">¶</a></dt>
 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
 <p>Convenience class for easily processing NVFIX strings.</p>
-<p>Constructor arguments:</p>
+<p><strong>Constructor Arguments:</strong></p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>separator</strong> &#8211; The delimiter to expect between NVFIX fields. Defaults to \\x01 if no delimiter is provided.</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>delimiter</strong> &#8211; The delimiter to expect between NVFIX fields. Defaults to \x01 if no delimiter is provided.</td>
 </tr>
 </tbody>
 </table>
@@ -6112,6 +6463,20 @@ fields in the message.</p>
 <p>AMPS PublishStore Object</p>
 <p>Stores published records in a file while awaiting an ACK from the server. Construct with the name of the file to use for record storage
 and optionally, a Boolean to specify if the store should throw an exception if logging onto a server that might be missing messages not in the store.</p>
+<dl class="method">
+<dt id="AMPS.PublishStore.discard_up_to">
+<code class="descname">discard_up_to</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.PublishStore.discard_up_to" title="Permalink to this definition">¶</a></dt>
+<dd><p>Discard all messages in the publish store with a sequence number less than or equal to the provided argument.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>sequence</strong> &#8211; The highest sequence number to discard.</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
 <dl class="method">
 <dt id="AMPS.PublishStore.get_error_on_publish_gap">
 <code class="descname">get_error_on_publish_gap</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.PublishStore.get_error_on_publish_gap" title="Permalink to this definition">¶</a></dt>
@@ -6122,12 +6487,39 @@ appears to be missing messages no longer held in the store.</dd>
 </dl>
 </dd></dl>
+<dl class="method">
+<dt id="AMPS.PublishStore.get_last_persisted">
+<code class="descname">get_last_persisted</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.PublishStore.get_last_persisted" title="Permalink to this definition">¶</a></dt>
+<dd><p>Returns the sequence number of last message ACK&#8217;ed by the server.</p>
+</dd></dl>
+<dl class="method">
+<dt id="AMPS.PublishStore.get_lowest_unpersisted">
+<code class="descname">get_lowest_unpersisted</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.PublishStore.get_lowest_unpersisted" title="Permalink to this definition">¶</a></dt>
+<dd><p>Returns the sequence number of the oldest message in the publish store.</p>
+</dd></dl>
 <dl class="method">
 <dt id="AMPS.PublishStore.get_unpersisted_count">
 <code class="descname">get_unpersisted_count</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.PublishStore.get_unpersisted_count" title="Permalink to this definition">¶</a></dt>
 <dd><p>Returns the number of messages published which have not been ACK&#8217;ed by the server.</p>
 </dd></dl>
+<dl class="method">
+<dt id="AMPS.PublishStore.replay">
+<code class="descname">replay</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.PublishStore.replay" title="Permalink to this definition">¶</a></dt>
+<dd><p>Replays all messages currently in the publish store via the provided message handler.
+:param handler: The message handler to call with each message.</p>
+</dd></dl>
+<dl class="method">
+<dt id="AMPS.PublishStore.replay_single">
+<code class="descname">replay_single</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.PublishStore.replay_single" title="Permalink to this definition">¶</a></dt>
+<dd><p>Replays the message with the given sequence number if it is currently in the publish store via the provided message handler.
+:param handler: The message handler to call with each message.
+:param sequence: The sequence number of the message to replay.</p>
+</dd></dl>
 <dl class="method">
 <dt id="AMPS.PublishStore.set_error_on_publish_gap">
 <code class="descname">set_error_on_publish_gap</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.PublishStore.set_error_on_publish_gap" title="Permalink to this definition">¶</a></dt>
@@ -6150,6 +6542,20 @@ appears to be missing messages no longer held in the store.</td>
 <dd><p>Sets the object to call when the store needs to resize.</p>
 </dd></dl>
+<dl class="method">
+<dt id="AMPS.PublishStore.store">
+<code class="descname">store</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.PublishStore.store" title="Permalink to this definition">¶</a></dt>
+<dd><p>Store the provided message into the publish store. Returns the sequence number that should be assigned to the message.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>message</strong> &#8211; The message to put into the store.</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
 <dl class="method">
 <dt id="AMPS.PublishStore.truncate_on_close">
 <code class="descname">truncate_on_close</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.PublishStore.truncate_on_close" title="Permalink to this definition">¶</a></dt>
@@ -6512,6 +6918,12 @@ for exceptions.</td>
 </dd></dl>
+<dl class="function">
+<dt id="AMPS.ssl_get_context">
+<code class="descclassname">AMPS.</code><code class="descname">ssl_get_context</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.ssl_get_context" title="Permalink to this definition">¶</a></dt>
+<dd><p>Returns the SSLContext used for SSL connections. Call ssl_init first.</p>
+</dd></dl>
 <dl class="function">
 <dt id="AMPS.ssl_init">
 <code class="descclassname">AMPS.</code><code class="descname">ssl_init</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#AMPS.ssl_init" title="Permalink to this definition">¶</a></dt>
@@ -6520,8 +6932,18 @@ for exceptions.</td>
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>dllpath</strong> &#8211; The path to the OpenSSL DLL or shared library to use for
-SSL functionality.</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>dllpath</strong> &#8211; The path to the OpenSSL DLL or shared library to use for
+SSL functionality.</li>
+<li><strong>ssl_context</strong> &#8211; An ssl.SSLContext preconfigured with desired settings
+for tcps connections to the AMPS server.</li>
+<li><strong>strict_ciphers_only</strong> &#8211; If True, use only the stricter ciphers allowed
+by default in Python version 3.10 and above. The
+default is False, which enables all default
+OpenSSL ciphers for compatibility with some AMPS
+versions using older OpenSSL libraries.</li>
+</ul>
+</td>
 </tr>
 </tbody>
 </table>
@@ -6605,7 +7027,7 @@ SSL functionality.</td>
         <li class="right" >
           <a href="index.html" title="AMPS Python Client Reference"
              >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">AMPS Python Client 5.3.4.2 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">AMPS Python Client 5.3.4.4 documentation</a> &#187;</li>
       </ul>
     </div>
     <div class="footer" role="contentinfo">

amps-python-client 5.3.4.2__zip → 5.3.4.4__zip

amps-python-client 5.3.4.2zip → 5.3.4.4zip