PyPI - amps-python-client - Versions diffs - 5.3.4.1__zip - Mend

amps-python-client 5.3.4.1__zip

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 (550) hide show

amps-python-client-5.3.4.1/docs/command-reference/html/chapters/protocol-reference.html ADDED Viewed

@@ -0,0 +1,1190 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <title>10. Protocol Reference &#8212; Advanced Message Processing System (AMPS) Command Reference develop
+ documentation</title>
+    <link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
+    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+    <script type="text/javascript">
+      var DOCUMENTATION_OPTIONS = {
+        URL_ROOT:    '../',
+        VERSION:     'develop',
+        COLLAPSE_INDEX: false,
+        FILE_SUFFIX: '.html',
+        HAS_SOURCE:  true,
+        SOURCELINK_SUFFIX: '.txt'
+      };
+    </script>
+    <script type="text/javascript" src="../_static/jquery.js"></script>
+    <script type="text/javascript" src="../_static/underscore.js"></script>
+    <script type="text/javascript" src="../_static/doctools.js"></script>
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" />
+    <link rel="prev" title="9. Query Result Set Delimiters" href="query-delimiters.html" />
+  <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
+  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+  </head>
+  <body role="document">
+  <div class="document">
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+        <div class="sphinxsidebarwrapper">
+            <p class="logo"><a href="../index.html">
+              <img class="logo" src="../_static/flag_logo.png" alt="Logo"/>
+            </a></p>
+  <h3><a href="../index.html">Table Of Contents</a></h3>
+  <ul>
+<li><a class="reference internal" href="#">10. Protocol Reference</a><ul>
+<li><a class="reference internal" href="#fix-nvfix-protocol">FIX/NVFIX Protocol</a><ul>
+<li><a class="reference internal" href="#fix-nvfix-message-header-sorted-by-value">FIX/NVFIX Message Header - Sorted by Value</a></li>
+<li><a class="reference internal" href="#fix-nvfix-message-header-sorted-by-name">FIX/NVFIX Message Header - Sorted by Name</a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#xml-protocol">XML Protocol</a><ul>
+<li><a class="reference internal" href="#xml-message-header-sorted-by-name">XML Message Header - Sorted by Name</a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#amps-protocol">AMPS Protocol</a><ul>
+<li><a class="reference internal" href="#amps-message-header-sorted-by-name">AMPS Message Header - Sorted by Name</a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#header-fields-reference">Header Fields - Reference</a></li>
+</ul>
+</li>
+</ul>
+<div class="relations">
+<h3>Related Topics</h3>
+<ul>
+  <li><a href="../index.html">Documentation overview</a><ul>
+      <li>Previous: <a href="query-delimiters.html" title="previous chapter">9. Query Result Set Delimiters</a></li>
+  </ul></li>
+</ul>
+</div>
+<div id="searchbox" style="display: none" role="search">
+  <h3>Quick search</h3>
+    <form class="search" action="../search.html" method="get">
+      <div><input type="text" name="q" /></div>
+      <div><input type="submit" value="Go" /></div>
+      <input type="hidden" name="check_keywords" value="yes" />
+      <input type="hidden" name="area" value="default" />
+    </form>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+        </div>
+      </div>
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body" role="main">
+  <div class="section" id="protocol-reference">
+<span id="command-ref-protocol"></span><h1>10. Protocol Reference<a class="headerlink" href="#protocol-reference" title="Permalink to this headline">¶</a></h1>
+<p>This section contains information on how different protocols represent
+AMPS headers. The AMPS clients handle constructing and parsing AMPS
+headers. However, understanding the format of command can be useful when
+inspecting trace level logs or network traffic captures.</p>
+<div class="admonition warning">
+<p class="first admonition-title">Warning</p>
+<p>The <code class="docutils literal"><span class="pre">amps</span></code> protocol is the recommended protocol for
+all application development. The other
+protocols are included for legacy compatibilty. While they
+will remain supported for their current functionality,
+the legacy protocols will not be enhanced further. These protocols
+have limitations in current versions of AMPS, and future features
+of AMPS may require the <code class="docutils literal"><span class="pre">amps</span></code> protocol.</p>
+<p class="last">(Notice that websocket connections use the websocket transport
+framing, but interact with AMPS using the <code class="docutils literal"><span class="pre">amps</span></code> protoco.)</p>
+</div>
+<div class="section" id="fix-nvfix-protocol">
+<h2>FIX/NVFIX Protocol<a class="headerlink" href="#fix-nvfix-protocol" title="Permalink to this headline">¶</a></h2>
+<p>The following table describes how the headers in
+the <code class="docutils literal"><span class="pre">fix</span></code> and <code class="docutils literal"><span class="pre">nvfix</span></code> protocols are processed
+by AMPS.</p>
+<div class="section" id="fix-nvfix-message-header-sorted-by-value">
+<h3>FIX/NVFIX Message Header - Sorted by Value<a class="headerlink" href="#fix-nvfix-message-header-sorted-by-value" title="Permalink to this headline">¶</a></h3>
+<table border="1" class="docutils">
+<colgroup>
+<col width="50%" />
+<col width="50%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head"><strong>FIX/NVFIX Header Field</strong></th>
+<th class="head"><strong>Name</strong></th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>20000</td>
+<td><code class="docutils literal"><span class="pre">Command</span></code></td>
+</tr>
+<tr class="row-odd"><td>20001</td>
+<td><code class="docutils literal"><span class="pre">CommandId</span></code></td>
+</tr>
+<tr class="row-even"><td>20002</td>
+<td><code class="docutils literal"><span class="pre">ClientName</span></code></td>
+</tr>
+<tr class="row-odd"><td>20003</td>
+<td><code class="docutils literal"><span class="pre">UserId</span></code></td>
+</tr>
+<tr class="row-even"><td>20004</td>
+<td><code class="docutils literal"><span class="pre">TransmissionTime</span></code></td>
+</tr>
+<tr class="row-odd"><td>20005</td>
+<td><code class="docutils literal"><span class="pre">Topic</span></code></td>
+</tr>
+<tr class="row-even"><td>20006</td>
+<td><code class="docutils literal"><span class="pre">Filter</span></code></td>
+</tr>
+<tr class="row-odd"><td>20007</td>
+<td><code class="docutils literal"><span class="pre">MessageType</span></code></td>
+</tr>
+<tr class="row-even"><td>20008</td>
+<td><code class="docutils literal"><span class="pre">AckType</span></code></td>
+</tr>
+<tr class="row-odd"><td>20009</td>
+<td><code class="docutils literal"><span class="pre">SubscriptionId</span></code></td>
+</tr>
+<tr class="row-even"><td>20011</td>
+<td><code class="docutils literal"><span class="pre">Version</span></code></td>
+</tr>
+<tr class="row-odd"><td>20012</td>
+<td><code class="docutils literal"><span class="pre">Expiration</span></code></td>
+</tr>
+<tr class="row-even"><td>20013</td>
+<td><code class="docutils literal"><span class="pre">SendSubscriptionIDs</span></code></td>
+</tr>
+<tr class="row-odd"><td>20014</td>
+<td><code class="docutils literal"><span class="pre">DataOnly</span></code></td>
+</tr>
+<tr class="row-even"><td>20015</td>
+<td><code class="docutils literal"><span class="pre">Heartbeat</span></code></td>
+</tr>
+<tr class="row-odd"><td>20016</td>
+<td><code class="docutils literal"><span class="pre">TimeoutInterval</span></code></td>
+</tr>
+<tr class="row-even"><td>20017</td>
+<td><code class="docutils literal"><span class="pre">LeasePeriod</span></code></td>
+</tr>
+<tr class="row-odd"><td>20018</td>
+<td><code class="docutils literal"><span class="pre">Status</span></code></td>
+</tr>
+<tr class="row-even"><td>20019</td>
+<td><code class="docutils literal"><span class="pre">QueryID</span></code></td>
+</tr>
+<tr class="row-odd"><td>20020</td>
+<td><code class="docutils literal"><span class="pre">SendOutOfFocus</span></code></td>
+</tr>
+<tr class="row-even"><td>20021</td>
+<td><code class="docutils literal"><span class="pre">LogLevel</span></code></td>
+</tr>
+<tr class="row-odd"><td>20022</td>
+<td><code class="docutils literal"><span class="pre">UseNamespaces</span></code></td>
+</tr>
+<tr class="row-even"><td>20023</td>
+<td><code class="docutils literal"><span class="pre">BatchSize</span></code></td>
+</tr>
+<tr class="row-odd"><td>20025</td>
+<td><code class="docutils literal"><span class="pre">TopNRecordsReturned</span></code></td>
+</tr>
+<tr class="row-even"><td>20029</td>
+<td><code class="docutils literal"><span class="pre">SendEmpty</span></code></td>
+</tr>
+<tr class="row-odd"><td>20031</td>
+<td><code class="docutils literal"><span class="pre">MaximumMessages</span></code></td>
+</tr>
+<tr class="row-even"><td>20032</td>
+<td><code class="docutils literal"><span class="pre">SowKeys</span></code></td>
+</tr>
+<tr class="row-odd"><td>20033</td>
+<td><code class="docutils literal"><span class="pre">SendKeys</span></code></td>
+</tr>
+<tr class="row-even"><td>20034</td>
+<td><code class="docutils literal"><span class="pre">Src</span></code></td>
+</tr>
+<tr class="row-odd"><td>20035</td>
+<td><code class="docutils literal"><span class="pre">CorrelationId</span></code></td>
+</tr>
+<tr class="row-even"><td>20036</td>
+<td><code class="docutils literal"><span class="pre">Sequence</span></code></td>
+</tr>
+<tr class="row-odd"><td>20037</td>
+<td><code class="docutils literal"><span class="pre">Bookmark</span></code></td>
+</tr>
+<tr class="row-even"><td>20038</td>
+<td><code class="docutils literal"><span class="pre">Password</span></code></td>
+</tr>
+<tr class="row-odd"><td>20039</td>
+<td><code class="docutils literal"><span class="pre">Options</span></code></td>
+</tr>
+<tr class="row-even"><td>20052</td>
+<td><code class="docutils literal"><span class="pre">RecordsInserted</span></code></td>
+</tr>
+<tr class="row-odd"><td>20053</td>
+<td><code class="docutils literal"><span class="pre">RecordsUpdated</span></code></td>
+</tr>
+<tr class="row-even"><td>20054</td>
+<td><code class="docutils literal"><span class="pre">RecordsDeleted</span></code></td>
+</tr>
+<tr class="row-odd"><td>20055</td>
+<td><code class="docutils literal"><span class="pre">RecordsReturned</span></code></td>
+</tr>
+<tr class="row-even"><td>20056</td>
+<td><code class="docutils literal"><span class="pre">TopicMatches</span></code></td>
+</tr>
+<tr class="row-odd"><td>20057</td>
+<td><code class="docutils literal"><span class="pre">Matches</span></code></td>
+</tr>
+<tr class="row-even"><td>20058</td>
+<td><code class="docutils literal"><span class="pre">MessageLength</span></code></td>
+</tr>
+<tr class="row-odd"><td>20059</td>
+<td><code class="docutils literal"><span class="pre">SowKey</span></code></td>
+</tr>
+<tr class="row-even"><td>20060</td>
+<td><code class="docutils literal"><span class="pre">GroupSequenceNumber</span></code></td>
+</tr>
+<tr class="row-odd"><td>20061</td>
+<td><code class="docutils literal"><span class="pre">SubscriptionIds</span></code></td>
+</tr>
+<tr class="row-even"><td>20062</td>
+<td><code class="docutils literal"><span class="pre">Reason</span></code></td>
+</tr>
+<tr class="row-odd"><td>20063</td>
+<td><code class="docutils literal"><span class="pre">MessageID</span></code></td>
+</tr>
+<tr class="row-even"><td>20074</td>
+<td><code class="docutils literal"><span class="pre">CorrelationID</span></code></td>
+</tr>
+</tbody>
+</table>
+</div>
+<div class="section" id="fix-nvfix-message-header-sorted-by-name">
+<h3>FIX/NVFIX Message Header - Sorted by Name<a class="headerlink" href="#fix-nvfix-message-header-sorted-by-name" title="Permalink to this headline">¶</a></h3>
+<table border="1" class="docutils">
+<colgroup>
+<col width="50%" />
+<col width="50%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head"><strong>FIX/NVFIX Header Field</strong></th>
+<th class="head"><strong>Name</strong></th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>20008</td>
+<td><code class="docutils literal"><span class="pre">AckTyp</span></code></td>
+</tr>
+<tr class="row-odd"><td>20037</td>
+<td><code class="docutils literal"><span class="pre">BkMrk</span></code></td>
+</tr>
+<tr class="row-even"><td>20023</td>
+<td><code class="docutils literal"><span class="pre">BtchSz</span></code></td>
+</tr>
+<tr class="row-odd"><td>20002</td>
+<td><code class="docutils literal"><span class="pre">ClntName</span></code></td>
+</tr>
+<tr class="row-even"><td>20000</td>
+<td><code class="docutils literal"><span class="pre">Cmd</span></code></td>
+</tr>
+<tr class="row-odd"><td>20001</td>
+<td><code class="docutils literal"><span class="pre">CmdId</span></code></td>
+</tr>
+<tr class="row-even"><td>20035</td>
+<td><code class="docutils literal"><span class="pre">CorrelationId</span></code></td>
+</tr>
+<tr class="row-odd"><td>20014</td>
+<td><code class="docutils literal"><span class="pre">DatOnly</span></code></td>
+</tr>
+<tr class="row-even"><td>20012</td>
+<td><code class="docutils literal"><span class="pre">Expn</span></code></td>
+</tr>
+<tr class="row-odd"><td>20006</td>
+<td><code class="docutils literal"><span class="pre">Fltr</span></code></td>
+</tr>
+<tr class="row-even"><td>20017</td>
+<td><code class="docutils literal"><span class="pre">GrcPrd</span></code></td>
+</tr>
+<tr class="row-odd"><td>20060</td>
+<td><code class="docutils literal"><span class="pre">GrpSqNum</span></code></td>
+</tr>
+<tr class="row-even"><td>20015</td>
+<td><code class="docutils literal"><span class="pre">Hrtbt</span></code></td>
+</tr>
+<tr class="row-odd"><td>20017</td>
+<td><code class="docutils literal"><span class="pre">LeasePeriod</span></code></td>
+</tr>
+<tr class="row-even"><td>20021</td>
+<td><code class="docutils literal"><span class="pre">LogLvl</span></code></td>
+</tr>
+<tr class="row-odd"><td>20057</td>
+<td><code class="docutils literal"><span class="pre">Matches</span></code></td>
+</tr>
+<tr class="row-even"><td>20063</td>
+<td><code class="docutils literal"><span class="pre">MsgId</span></code></td>
+</tr>
+<tr class="row-odd"><td>20058</td>
+<td><code class="docutils literal"><span class="pre">MsgLen</span></code></td>
+</tr>
+<tr class="row-even"><td>20007</td>
+<td><code class="docutils literal"><span class="pre">MsgTyp</span></code></td>
+</tr>
+<tr class="row-odd"><td>20031</td>
+<td><code class="docutils literal"><span class="pre">MxMsgs</span></code></td>
+</tr>
+<tr class="row-even"><td>20039</td>
+<td><code class="docutils literal"><span class="pre">Opts</span></code></td>
+</tr>
+<tr class="row-odd"><td>20038</td>
+<td><code class="docutils literal"><span class="pre">PW</span></code></td>
+</tr>
+<tr class="row-even"><td>20019</td>
+<td><code class="docutils literal"><span class="pre">Qld</span></code></td>
+</tr>
+<tr class="row-odd"><td>20062</td>
+<td><code class="docutils literal"><span class="pre">Reason</span></code></td>
+</tr>
+<tr class="row-even"><td>20054</td>
+<td><code class="docutils literal"><span class="pre">RecordsDeleted</span></code></td>
+</tr>
+<tr class="row-odd"><td>20053</td>
+<td><code class="docutils literal"><span class="pre">RecordsInserted</span></code></td>
+</tr>
+<tr class="row-even"><td>20055</td>
+<td><code class="docutils literal"><span class="pre">RecordsReturned</span></code></td>
+</tr>
+<tr class="row-odd"><td>20036</td>
+<td><code class="docutils literal"><span class="pre">Seq</span></code></td>
+</tr>
+<tr class="row-even"><td>20029</td>
+<td><code class="docutils literal"><span class="pre">SndEmpty</span></code></td>
+</tr>
+<tr class="row-odd"><td>20033</td>
+<td><code class="docutils literal"><span class="pre">SndKeys</span></code></td>
+</tr>
+<tr class="row-even"><td>20020</td>
+<td><code class="docutils literal"><span class="pre">SndOOF</span></code></td>
+</tr>
+<tr class="row-odd"><td>20013</td>
+<td><code class="docutils literal"><span class="pre">SndSubIds</span></code></td>
+</tr>
+<tr class="row-even"><td>20059</td>
+<td><code class="docutils literal"><span class="pre">SowKey</span></code></td>
+</tr>
+<tr class="row-odd"><td>20032</td>
+<td><code class="docutils literal"><span class="pre">SowKeys</span></code></td>
+</tr>
+<tr class="row-even"><td>20034</td>
+<td><code class="docutils literal"><span class="pre">Src</span></code></td>
+</tr>
+<tr class="row-odd"><td>20018</td>
+<td><code class="docutils literal"><span class="pre">Status</span></code></td>
+</tr>
+<tr class="row-even"><td>20009</td>
+<td><code class="docutils literal"><span class="pre">SubId</span></code></td>
+</tr>
+<tr class="row-odd"><td>20061</td>
+<td><code class="docutils literal"><span class="pre">SubIds</span></code></td>
+</tr>
+<tr class="row-even"><td>20016</td>
+<td><code class="docutils literal"><span class="pre">TmIntvl</span></code></td>
+</tr>
+<tr class="row-odd"><td>20025</td>
+<td><code class="docutils literal"><span class="pre">TopN</span></code></td>
+</tr>
+<tr class="row-even"><td>20056</td>
+<td><code class="docutils literal"><span class="pre">TopicMatches</span></code></td>
+</tr>
+<tr class="row-odd"><td>20005</td>
+<td><code class="docutils literal"><span class="pre">Tpc</span></code></td>
+</tr>
+<tr class="row-even"><td>20004</td>
+<td><code class="docutils literal"><span class="pre">TxmTm</span></code></td>
+</tr>
+<tr class="row-odd"><td>20022</td>
+<td><code class="docutils literal"><span class="pre">UseNs</span></code></td>
+</tr>
+<tr class="row-even"><td>20003</td>
+<td><code class="docutils literal"><span class="pre">UsrId</span></code></td>
+</tr>
+</tbody>
+</table>
+</div>
+</div>
+<div class="section" id="xml-protocol">
+<h2>XML Protocol<a class="headerlink" href="#xml-protocol" title="Permalink to this headline">¶</a></h2>
+<p>The following table describes how the headers in
+the <code class="docutils literal"><span class="pre">xml</span></code> protocol are processed
+by AMPS.</p>
+<div class="section" id="xml-message-header-sorted-by-name">
+<h3>XML Message Header - Sorted by Name<a class="headerlink" href="#xml-message-header-sorted-by-name" title="Permalink to this headline">¶</a></h3>
+<table border="1" class="docutils">
+<colgroup>
+<col width="50%" />
+<col width="50%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head"><strong>XML Header Field</strong></th>
+<th class="head"><strong>Name</strong></th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>AckTyp</td>
+<td><code class="docutils literal"><span class="pre">AckType</span></code></td>
+</tr>
+<tr class="row-odd"><td>BkMrk</td>
+<td><code class="docutils literal"><span class="pre">Bookmark</span></code></td>
+</tr>
+<tr class="row-even"><td>BtchSz</td>
+<td><code class="docutils literal"><span class="pre">BatchSize</span></code></td>
+</tr>
+<tr class="row-odd"><td>ClntName</td>
+<td><code class="docutils literal"><span class="pre">ClientName</span></code></td>
+</tr>
+<tr class="row-even"><td>Cmd</td>
+<td><code class="docutils literal"><span class="pre">Command</span></code></td>
+</tr>
+<tr class="row-odd"><td>CmdId</td>
+<td><code class="docutils literal"><span class="pre">CommandId</span></code></td>
+</tr>
+<tr class="row-even"><td>DatOnly</td>
+<td><code class="docutils literal"><span class="pre">DataOnly</span></code></td>
+</tr>
+<tr class="row-odd"><td>Expn</td>
+<td><code class="docutils literal"><span class="pre">Expiration</span></code></td>
+</tr>
+<tr class="row-even"><td>Fltr</td>
+<td><code class="docutils literal"><span class="pre">Filter</span></code></td>
+</tr>
+<tr class="row-odd"><td>GrcPrd</td>
+<td><code class="docutils literal"><span class="pre">GracePeriod</span></code></td>
+</tr>
+<tr class="row-even"><td>GrpSqNum</td>
+<td><code class="docutils literal"><span class="pre">GroupSequenceNumber</span></code></td>
+</tr>
+<tr class="row-odd"><td>Hrtbt</td>
+<td><code class="docutils literal"><span class="pre">Heartbeat</span></code></td>
+</tr>
+<tr class="row-even"><td>LeasePeriod</td>
+<td><code class="docutils literal"><span class="pre">LeasePeriod</span></code></td>
+</tr>
+<tr class="row-odd"><td>LogLvl</td>
+<td><code class="docutils literal"><span class="pre">LogLevel</span></code></td>
+</tr>
+<tr class="row-even"><td>Matches</td>
+<td><code class="docutils literal"><span class="pre">Matches</span></code></td>
+</tr>
+<tr class="row-odd"><td>MsgId</td>
+<td><code class="docutils literal"><span class="pre">MessageID</span></code></td>
+</tr>
+<tr class="row-even"><td>MsgLen</td>
+<td><code class="docutils literal"><span class="pre">MessageLength</span></code></td>
+</tr>
+<tr class="row-odd"><td>MsgTyp</td>
+<td><code class="docutils literal"><span class="pre">MessageType</span></code></td>
+</tr>
+<tr class="row-even"><td>MxMsgs</td>
+<td><code class="docutils literal"><span class="pre">MaximumMessages</span></code></td>
+</tr>
+<tr class="row-odd"><td>Opts</td>
+<td><code class="docutils literal"><span class="pre">Opts</span></code></td>
+</tr>
+<tr class="row-even"><td>PW</td>
+<td><code class="docutils literal"><span class="pre">Password</span></code></td>
+</tr>
+<tr class="row-odd"><td>QId</td>
+<td><code class="docutils literal"><span class="pre">QueryID</span></code></td>
+</tr>
+<tr class="row-even"><td>Reason</td>
+<td><code class="docutils literal"><span class="pre">Reason</span></code></td>
+</tr>
+<tr class="row-odd"><td>RecordsDeleted</td>
+<td><code class="docutils literal"><span class="pre">RecordsDeleted</span></code></td>
+</tr>
+<tr class="row-even"><td>RecordsReturned</td>
+<td><code class="docutils literal"><span class="pre">RecordsReturned</span></code></td>
+</tr>
+<tr class="row-odd"><td>Seq</td>
+<td><code class="docutils literal"><span class="pre">Sequence</span></code></td>
+</tr>
+<tr class="row-even"><td>SndEmpty</td>
+<td><code class="docutils literal"><span class="pre">SendEmpty</span></code></td>
+</tr>
+<tr class="row-odd"><td>SndKeys</td>
+<td><code class="docutils literal"><span class="pre">SendKeys</span></code></td>
+</tr>
+<tr class="row-even"><td>SndOOF</td>
+<td><code class="docutils literal"><span class="pre">SendOutOfFocus</span></code></td>
+</tr>
+<tr class="row-odd"><td>SndSubIds</td>
+<td><code class="docutils literal"><span class="pre">SendSubscriptionIDs</span></code></td>
+</tr>
+<tr class="row-even"><td>SowKey</td>
+<td><code class="docutils literal"><span class="pre">SowKey</span></code></td>
+</tr>
+<tr class="row-odd"><td>SowKeys</td>
+<td><code class="docutils literal"><span class="pre">SowKeys</span></code></td>
+</tr>
+<tr class="row-even"><td>Status</td>
+<td><code class="docutils literal"><span class="pre">Status</span></code></td>
+</tr>
+<tr class="row-odd"><td>SubId</td>
+<td><code class="docutils literal"><span class="pre">SubscriptionId</span></code></td>
+</tr>
+<tr class="row-even"><td>SubIds</td>
+<td><code class="docutils literal"><span class="pre">SubscriptionIds</span></code></td>
+</tr>
+<tr class="row-odd"><td>TmIntvl</td>
+<td><code class="docutils literal"><span class="pre">TimeoutInterval</span></code></td>
+</tr>
+<tr class="row-even"><td>TopN</td>
+<td><code class="docutils literal"><span class="pre">TopNRecordsReturned</span></code></td>
+</tr>
+<tr class="row-odd"><td>TopicMatches</td>
+<td><code class="docutils literal"><span class="pre">TopicMatches</span></code></td>
+</tr>
+<tr class="row-even"><td>Tpc</td>
+<td><code class="docutils literal"><span class="pre">Topic</span></code></td>
+</tr>
+<tr class="row-odd"><td>TxmTm</td>
+<td><code class="docutils literal"><span class="pre">TransmissionTime</span></code></td>
+</tr>
+<tr class="row-even"><td>UseNS</td>
+<td><code class="docutils literal"><span class="pre">UseNamespaces</span></code></td>
+</tr>
+<tr class="row-odd"><td>UsrId</td>
+<td><code class="docutils literal"><span class="pre">UserId</span></code></td>
+</tr>
+</tbody>
+</table>
+</div>
+</div>
+<div class="section" id="amps-protocol">
+<h2>AMPS Protocol<a class="headerlink" href="#amps-protocol" title="Permalink to this headline">¶</a></h2>
+<p>The following table describes how the headers in
+the <code class="docutils literal"><span class="pre">amps</span></code> protocol are processed
+by AMPS.</p>
+<p>Current releases of AMPS use a simplified
+JSON-like syntax for the <code class="docutils literal"><span class="pre">amps</span></code> protocol.</p>
+<div class="section" id="amps-message-header-sorted-by-name">
+<h3>AMPS Message Header - Sorted by Name<a class="headerlink" href="#amps-message-header-sorted-by-name" title="Permalink to this headline">¶</a></h3>
+<table border="1" class="docutils">
+<colgroup>
+<col width="33%" />
+<col width="33%" />
+<col width="33%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head"><strong>AMPS Header Field</strong></th>
+<th class="head"><strong>Abbreviation</strong></th>
+<th class="head"><strong>Name</strong></th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>ack_type</td>
+<td>a</td>
+<td><code class="docutils literal"><span class="pre">AckType</span></code></td>
+</tr>
+<tr class="row-odd"><td>password</td>
+<td>pw</td>
+<td><code class="docutils literal"><span class="pre">Password</span></code></td>
+</tr>
+<tr class="row-even"><td>bookmark</td>
+<td>bm</td>
+<td><code class="docutils literal"><span class="pre">Bookmark</span></code></td>
+</tr>
+<tr class="row-odd"><td>batch_size</td>
+<td>bs</td>
+<td><code class="docutils literal"><span class="pre">BatchSize</span></code></td>
+</tr>
+<tr class="row-even"><td>client_name</td>
+<td>&#160;</td>
+<td><code class="docutils literal"><span class="pre">ClientName</span></code></td>
+</tr>
+<tr class="row-odd"><td>cmd</td>
+<td>c</td>
+<td><code class="docutils literal"><span class="pre">Command</span></code></td>
+</tr>
+<tr class="row-even"><td>cmd_id</td>
+<td>cid</td>
+<td><code class="docutils literal"><span class="pre">CommandId</span></code></td>
+</tr>
+<tr class="row-odd"><td>correlation_id</td>
+<td>x</td>
+<td><code class="docutils literal"><span class="pre">CorrelationId</span></code></td>
+</tr>
+<tr class="row-even"><td>data_only</td>
+<td>&#160;</td>
+<td><code class="docutils literal"><span class="pre">DataOnly</span></code></td>
+</tr>
+<tr class="row-odd"><td>expiration</td>
+<td>e</td>
+<td><code class="docutils literal"><span class="pre">Expiration</span></code></td>
+</tr>
+<tr class="row-even"><td>filter</td>
+<td>f</td>
+<td><code class="docutils literal"><span class="pre">Filter</span></code></td>
+</tr>
+<tr class="row-odd"><td>gseq</td>
+<td>&#160;</td>
+<td><code class="docutils literal"><span class="pre">GroupSequenceNumber</span></code></td>
+</tr>
+<tr class="row-even"><td>heartbeat</td>
+<td>&#160;</td>
+<td><code class="docutils literal"><span class="pre">Heartbeat</span></code></td>
+</tr>
+<tr class="row-odd"><td>leaseperiod</td>
+<td>lp</td>
+<td><code class="docutils literal"><span class="pre">LeasePeriod</span></code></td>
+</tr>
+<tr class="row-even"><td>matches</td>
+<td>&#160;</td>
+<td><code class="docutils literal"><span class="pre">Matches</span></code></td>
+</tr>
+<tr class="row-odd"><td>msg_len</td>
+<td>l</td>
+<td><code class="docutils literal"><span class="pre">MessageLength</span></code></td>
+</tr>
+<tr class="row-even"><td>max_msgs</td>
+<td>&#160;</td>
+<td><code class="docutils literal"><span class="pre">MaximumMessages</span></code></td>
+</tr>
+<tr class="row-odd"><td>opts</td>
+<td>o</td>
+<td><code class="docutils literal"><span class="pre">Opts</span></code></td>
+</tr>
+<tr class="row-even"><td>orderby</td>
+<td>&#160;</td>
+<td><code class="docutils literal"><span class="pre">OrderBy</span></code></td>
+</tr>
+<tr class="row-odd"><td>query_id</td>
+<td>&#160;</td>
+<td><code class="docutils literal"><span class="pre">QueryID</span></code></td>
+</tr>
+<tr class="row-even"><td>reason</td>
+<td>&#160;</td>
+<td><code class="docutils literal"><span class="pre">Reason</span></code></td>
+</tr>
+<tr class="row-odd"><td>records_deleted</td>
+<td>&#160;</td>
+<td><code class="docutils literal"><span class="pre">RecordsDeleted</span></code></td>
+</tr>
+<tr class="row-even"><td>records_inserted</td>
+<td>&#160;</td>
+<td><code class="docutils literal"><span class="pre">RecordsInserted</span></code></td>
+</tr>
+<tr class="row-odd"><td>records_returned</td>
+<td>&#160;</td>
+<td><code class="docutils literal"><span class="pre">RecordsReturned</span></code></td>
+</tr>
+<tr class="row-even"><td>records_updated</td>
+<td>&#160;</td>
+<td><code class="docutils literal"><span class="pre">RecordsUpdated</span></code></td>
+</tr>
+<tr class="row-odd"><td>seq</td>
+<td>s</td>
+<td><code class="docutils literal"><span class="pre">Sequence</span></code></td>
+</tr>
+<tr class="row-even"><td>send_empty</td>
+<td>&#160;</td>
+<td><code class="docutils literal"><span class="pre">SendEmpty</span></code></td>
+</tr>
+<tr class="row-odd"><td>send_keys</td>
+<td>&#160;</td>
+<td><code class="docutils literal"><span class="pre">SendKeys</span></code></td>
+</tr>
+<tr class="row-even"><td>send_oof</td>
+<td>&#160;</td>
+<td><code class="docutils literal"><span class="pre">SendOutOfFocus</span></code></td>
+</tr>
+<tr class="row-odd"><td>sow_key</td>
+<td>k</td>
+<td><code class="docutils literal"><span class="pre">SowKey</span></code></td>
+</tr>
+<tr class="row-even"><td>sow_keys</td>
+<td>&#160;</td>
+<td><code class="docutils literal"><span class="pre">SowKeys</span></code></td>
+</tr>
+<tr class="row-odd"><td>status</td>
+<td>&#160;</td>
+<td><code class="docutils literal"><span class="pre">Status</span></code></td>
+</tr>
+<tr class="row-even"><td>sub_id</td>
+<td>&#160;</td>
+<td><code class="docutils literal"><span class="pre">SubscriptionId</span></code></td>
+</tr>
+<tr class="row-odd"><td>sids</td>
+<td>&#160;</td>
+<td><code class="docutils literal"><span class="pre">SubscriptionIds</span></code></td>
+</tr>
+<tr class="row-even"><td>src</td>
+<td>&#160;</td>
+<td><code class="docutils literal"><span class="pre">Src</span></code></td>
+</tr>
+<tr class="row-odd"><td>timeout_interval</td>
+<td>&#160;</td>
+<td><code class="docutils literal"><span class="pre">TimeoutInterval</span></code></td>
+</tr>
+<tr class="row-even"><td>timestamp</td>
+<td>ts</td>
+<td><code class="docutils literal"><span class="pre">TransmissionTime</span></code></td>
+</tr>
+<tr class="row-odd"><td>top_n</td>
+<td>&#160;</td>
+<td><code class="docutils literal"><span class="pre">TopNRecordsReturned</span></code></td>
+</tr>
+<tr class="row-even"><td>topic_matches</td>
+<td>&#160;</td>
+<td><code class="docutils literal"><span class="pre">TopicMatches</span></code></td>
+</tr>
+<tr class="row-odd"><td>topic</td>
+<td>t</td>
+<td><code class="docutils literal"><span class="pre">Topic</span></code></td>
+</tr>
+<tr class="row-even"><td>use_ns</td>
+<td>&#160;</td>
+<td><code class="docutils literal"><span class="pre">UseNamespaces</span></code></td>
+</tr>
+<tr class="row-odd"><td>user_id</td>
+<td>&#160;</td>
+<td><code class="docutils literal"><span class="pre">UserId</span></code></td>
+</tr>
+<tr class="row-even"><td>version</td>
+<td>v</td>
+<td><code class="docutils literal"><span class="pre">Version</span></code></td>
+</tr>
+</tbody>
+</table>
+</div>
+</div>
+<div class="section" id="header-fields-reference">
+<h2>Header Fields - Reference<a class="headerlink" href="#header-fields-reference" title="Permalink to this headline">¶</a></h2>
+<p>This section provides a reference to the header fields that have been used in
+AMPS messages. Not all headers are present on all outgoing messages, and not
+all headers are processed on incoming commands. See the detailed message
+descriptions in this guide for descriptions of which fields are used on
+a given command or a given response from AMPS. Further, although this
+table lists the header fields defined in every protocol, current versions
+of AMPS may not use every header defined in this table (see the detailed
+message descriptions for which fields are relevant for a given command or
+response).</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="33%" />
+<col width="33%" />
+<col width="33%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head"><strong>Name</strong></th>
+<th class="head"><strong>Type</strong></th>
+<th class="head"><strong>Definition</strong></th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">AckType</span></code></td>
+<td>string</td>
+<td>Acknowledgment type for
+the given command.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">BatchSize</span></code></td>
+<td>Integer. Default is 1
+when not present.</td>
+<td>Specifies the number of
+messages that are
+batched together when
+returning a query
+result.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">Bookmark</span></code></td>
+<td>string</td>
+<td>A client-originated
+identifier used to mark
+a location in journaled
+messages.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">ClientName</span></code></td>
+<td>string</td>
+<td>Used to identify a
+client. Useful for
+publishers that wish to
+identify the source of a
+publish, client status
+messages and for client
+heartbeats. Can be set
+with <code class="docutils literal"><span class="pre">logon</span></code> command.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">Command</span></code></td>
+<td><p class="first">One of:</p>
+<ul class="last simple">
+<li><code class="docutils literal"><span class="pre">publish</span></code></li>
+<li><code class="docutils literal"><span class="pre">subscribe</span></code></li>
+<li><code class="docutils literal"><span class="pre">sow</span></code></li>
+<li><code class="docutils literal"><span class="pre">sow_and_subscribe</span></code></li>
+<li><code class="docutils literal"><span class="pre">sow_delete</span></code></li>
+<li><code class="docutils literal"><span class="pre">unsubscribe</span></code></li>
+<li><code class="docutils literal"><span class="pre">flush</span></code></li>
+<li><code class="docutils literal"><span class="pre">heartbeat</span></code></li>
+<li><code class="docutils literal"><span class="pre">logon</span></code></li>
+</ul>
+</td>
+<td>Command to be executed.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">CommandId</span></code></td>
+<td>string</td>
+<td>Client-specified command
+id. The <code class="docutils literal"><span class="pre">CmdId</span></code> is
+returned by the engine
+in responses to commands
+to allow the client to
+correlate the response
+to the command.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">CorrelationId</span></code></td>
+<td>string, base64 encoded
+characters only</td>
+<td>Opaque token set by an
+application and returned
+with the message.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">DataOnly</span></code></td>
+<td>Boolean (<code class="docutils literal"><span class="pre">true</span></code> or
+<code class="docutils literal"><span class="pre">false</span></code>)</td>
+<td>If <code class="docutils literal"><span class="pre">true</span></code>, only send
+raw data to subscriber
+for a matching publish
+message, i.e. do not
+include FIX/NVFIX
+envelope.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">Expiration</span></code></td>
+<td>integer (seconds)</td>
+<td>SOW expiration time if
+used in <code class="docutils literal"><span class="pre">publish</span></code>.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">Filter</span></code></td>
+<td>string, should wrap in
+CDATA</td>
+<td>Content filter
+expression.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">GracePeriod</span></code></td>
+<td>integer (milliseconds)</td>
+<td>Grace period after
+heartbeat interval is
+exceeded before client
+is considered in error
+state.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">GroupSequenceNumber</span></code></td>
+<td>integer</td>
+<td>Group Sequence Number
+returned with each batch
+message of a SOW
+response.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">Heartbeat</span></code></td>
+<td>one of: <code class="docutils literal"><span class="pre">start</span></code>,
+<code class="docutils literal"><span class="pre">stop</span></code>, <code class="docutils literal"><span class="pre">beat</span></code></td>
+<td>Heartbeat command.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">LeasePeriod</span></code></td>
+<td>timestamp</td>
+<td>For messages from a
+queue, the time at which
+the lease expires.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">LogLevel</span></code></td>
+<td>one of: <code class="docutils literal"><span class="pre">info</span></code>,
+<code class="docutils literal"><span class="pre">none</span></code></td>
+<td><p class="first">Set the log level.</p>
+<p><em>Deprecated</em></p>
+<p class="last">Not used in current versions
+of AMPS.</p>
+</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">Matches</span></code></td>
+<td>integer</td>
+<td>Returned in the
+acknowledgment to a SOW
+query that indicates
+number of matches.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">MaximumMessages</span></code></td>
+<td>integer greater than
+zero</td>
+<td>Specifies the maximum
+number of messages
+within a batch publish.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">MessageID</span></code></td>
+<td>string, e.g.
+<code class="docutils literal"><span class="pre">MAMPS–XYZ</span></code></td>
+<td>Set by AMPS engine to
+tag every incoming
+message.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">MessageLength</span></code></td>
+<td>integer</td>
+<td>Sent with XML formatted
+message data to indicate
+the number of bytes used
+by the message body.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">MessageType</span></code></td>
+<td><p class="first">string</p>
+<p class="last">one of the configured message
+types in AMPS</p>
+</td>
+<td>Message type.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">Opts</span></code></td>
+<td>string</td>
+<td>A comma-delimited list
+of options on a specific
+command.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">Password</span></code></td>
+<td>string</td>
+<td>Password used to
+authenticate with an
+AMPS server.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">QueryID</span></code></td>
+<td>string</td>
+<td>SOW Query identifier set
+by client to identify a
+query.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">Reason</span></code></td>
+<td>string</td>
+<td>The failure message that
+appears when an
+acknowledgment returns
+a <code class="docutils literal"><span class="pre">status</span></code> of
+<code class="docutils literal"><span class="pre">failure</span></code>.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">RecordsDeleted</span></code></td>
+<td>integer</td>
+<td>Used in conjunction with
+the <code class="docutils literal"><span class="pre">stats</span></code>
+acknowledgment, this is
+the number of records
+deleted from the SOW
+with a <code class="docutils literal"><span class="pre">sow_delete</span></code>
+command.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">RecordsInserted</span></code></td>
+<td>integer</td>
+<td>Used in conjunction with
+the <code class="docutils literal"><span class="pre">stats</span></code>
+acknowledgment, this is
+the number of records
+inserted into the SOW.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">RecordsUpdated</span></code></td>
+<td>integer</td>
+<td>Used in conjunction with
+the <code class="docutils literal"><span class="pre">stats</span></code>
+acknowledgment, this is
+the number of records
+updated in the SOW.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">RecordsReturned</span></code></td>
+<td>integer</td>
+<td>Returned in the
+acknowledgment to an
+SOW query that indicates
+number of records in the
+store.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">SendEmpty</span></code></td>
+<td>Boolean (<code class="docutils literal"><span class="pre">true</span></code> or
+<code class="docutils literal"><span class="pre">false</span></code>); default is
+<code class="docutils literal"><span class="pre">true</span></code></td>
+<td>If <code class="docutils literal"><span class="pre">true</span></code>, empty
+messages that are
+published will be
+forwarded to matching
+subscriptions.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">SendKeys</span></code></td>
+<td>Boolean (<code class="docutils literal"><span class="pre">true</span></code> or
+<code class="docutils literal"><span class="pre">false</span></code>)</td>
+<td>Option to instruct AMPS
+that a client would like
+to receive the SowKey(s)
+back.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">SendOutOfFocus</span></code></td>
+<td>Boolean (<code class="docutils literal"><span class="pre">true</span></code> or
+<code class="docutils literal"><span class="pre">false</span></code>)</td>
+<td>If <code class="docutils literal"><span class="pre">true</span></code>,
+Out-of-Focus messages
+are sent for the SOW
+query.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">SendSubscriptionIDs</span></code></td>
+<td>Boolean (<code class="docutils literal"><span class="pre">true</span></code> or
+<code class="docutils literal"><span class="pre">false</span></code>)</td>
+<td>If <code class="docutils literal"><span class="pre">false</span></code>,
+subscription identifiers
+will not be sent for a
+matched message.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">Sequence</span></code></td>
+<td>integer greater than
+zero</td>
+<td>An integer that
+corresponds to the
+publish message sequence
+number. For more
+information see the
+Replication section in
+the User Guide.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">SowKey</span></code></td>
+<td><p class="first">string containing the
+digits of an unsigned
+long for AMPS-generated
+SOW keys</p>
+<p class="last">arbitrary string in the
+base64 character set for
+user-provided SOW keys</p>
+</td>
+<td><p class="first">A <code class="docutils literal"><span class="pre">SowKey</span></code> will
+accompany each message
+returned in an SOW
+batch. A <code class="docutils literal"><span class="pre">SowKey</span></code> may
+also be added to
+messages coming in on a
+subscription when the
+published message
+matches a record in the
+SOW.</p>
+<p class="last">A <code class="docutils literal"><span class="pre">publish</span></code> command
+may contain a SOW key if
+the SOW for the topic is
+configured to accept
+user-provided SOW keys.</p>
+</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">SowKeys</span></code></td>
+<td>comma-separated list of
+<code class="docutils literal"><span class="pre">SowKey</span></code> values</td>
+<td>Comma-separated list of
+<code class="docutils literal"><span class="pre">SowKey</span></code> values.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">Status</span></code></td>
+<td>one of: <code class="docutils literal"><span class="pre">stopped</span></code>,
+<code class="docutils literal"><span class="pre">alive</span></code>,
+<code class="docutils literal"><span class="pre">timed</span> <span class="pre">out</span></code>, <code class="docutils literal"><span class="pre">error</span></code></td>
+<td>Used to indicate client
+status when client is
+monitored for
+heartbeats.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">SubscriptionId</span></code></td>
+<td>string, e.g.
+<code class="docutils literal"><span class="pre">SAMPS-XYZ</span></code></td>
+<td>The subscription
+identifier set by server
+when processing a
+subscription.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">SubscriptionIds</span></code></td>
+<td>string</td>
+<td>Comma-separated list of
+<code class="docutils literal"><span class="pre">SubIds</span></code> sent from
+AMPS engine to identify
+which client
+subscriptions match a
+given publish message.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">TimeoutInterval</span></code></td>
+<td>integer</td>
+<td>Used in conjunction with
+the heartbeat interval
+to set the timeout
+interval for a
+publisher.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">TopNRecordsReturned</span></code></td>
+<td>unsigned integer</td>
+<td>The number of records to
+return. Note: If
+<code class="docutils literal"><span class="pre">TopN</span></code> is not equally
+divisible by the
+<code class="docutils literal"><span class="pre">BtchSz</span></code>, then more
+records will be returned
+so that the total number
+of records is equally
+divisible by the
+<code class="docutils literal"><span class="pre">BtchSz</span></code> setting.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">Topic</span></code></td>
+<td>string</td>
+<td>Topic</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">TopicMatches</span></code></td>
+<td>integer</td>
+<td>Returned in the
+acknowledgment to an
+SOW query that indicates
+number of topic matches.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">TransmissionTime</span></code></td>
+<td>ISO-8601 date-time</td>
+<td>Timestamp: optionally
+set to time the message
+was processed by the server.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">UseNamespaces</span></code></td>
+<td>Boolean (<code class="docutils literal"><span class="pre">true</span></code> or
+<code class="docutils literal"><span class="pre">false</span></code>)</td>
+<td>Use SOAP XML namespaces
+in all messages from the
+AMPS engine.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">UserId</span></code></td>
+<td>string</td>
+<td>Used to identify the
+user id of a command.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">Version</span></code></td>
+<td>string</td>
+<td>Contains the version of
+the AMPS server.</td>
+</tr>
+</tbody>
+</table>
+</div>
+</div>
+          </div>
+        </div>
+      </div>
+    <div class="clearer"></div>
+  </div>
+    <div class="footer">
+      &copy;2022, 60East Technologies, Inc..
+      |
+      Powered by <a href="http://sphinx-doc.org/">Sphinx 1.5.3</a>
+      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
+    </div>
+  </body>
+</html>