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
  1. amps-python-client-5.3.4.1/HISTORY +7 -0
  2. amps-python-client-5.3.4.1/LICENSE +157 -0
  3. amps-python-client-5.3.4.1/PKG-INFO +112 -0
  4. amps-python-client-5.3.4.1/README.md +96 -0
  5. amps-python-client-5.3.4.1/docs/command-reference/doctrees/chapters/ack-messages.doctree +0 -0
  6. amps-python-client-5.3.4.1/docs/command-reference/doctrees/chapters/content-messages.doctree +0 -0
  7. amps-python-client-5.3.4.1/docs/command-reference/doctrees/chapters/intro.doctree +0 -0
  8. amps-python-client-5.3.4.1/docs/command-reference/doctrees/chapters/logon.doctree +0 -0
  9. amps-python-client-5.3.4.1/docs/command-reference/doctrees/chapters/protocol-reference.doctree +0 -0
  10. amps-python-client-5.3.4.1/docs/command-reference/doctrees/chapters/publishing.doctree +0 -0
  11. amps-python-client-5.3.4.1/docs/command-reference/doctrees/chapters/query-delimiters.doctree +0 -0
  12. amps-python-client-5.3.4.1/docs/command-reference/doctrees/chapters/query-subscribe.doctree +0 -0
  13. amps-python-client-5.3.4.1/docs/command-reference/doctrees/chapters/removing.doctree +0 -0
  14. amps-python-client-5.3.4.1/docs/command-reference/doctrees/chapters/utilities.doctree +0 -0
  15. amps-python-client-5.3.4.1/docs/command-reference/doctrees/environment.pickle +0 -0
  16. amps-python-client-5.3.4.1/docs/command-reference/doctrees/index.doctree +0 -0
  17. amps-python-client-5.3.4.1/docs/command-reference/html/.buildinfo +4 -0
  18. amps-python-client-5.3.4.1/docs/command-reference/html/_images/caution.svg +25 -0
  19. amps-python-client-5.3.4.1/docs/command-reference/html/_sources/chapters/ack-messages.rst.txt +32 -0
  20. amps-python-client-5.3.4.1/docs/command-reference/html/_sources/chapters/content-messages.rst.txt +27 -0
  21. amps-python-client-5.3.4.1/docs/command-reference/html/_sources/chapters/intro.rst.txt +43 -0
  22. amps-python-client-5.3.4.1/docs/command-reference/html/_sources/chapters/logon.rst.txt +231 -0
  23. amps-python-client-5.3.4.1/docs/command-reference/html/_sources/chapters/protocol-reference.rst.txt +1474 -0
  24. amps-python-client-5.3.4.1/docs/command-reference/html/_sources/chapters/publishing.rst.txt +25 -0
  25. amps-python-client-5.3.4.1/docs/command-reference/html/_sources/chapters/query-delimiters.rst.txt +12 -0
  26. amps-python-client-5.3.4.1/docs/command-reference/html/_sources/chapters/query-subscribe.rst.txt +23 -0
  27. amps-python-client-5.3.4.1/docs/command-reference/html/_sources/chapters/removing.rst.txt +6 -0
  28. amps-python-client-5.3.4.1/docs/command-reference/html/_sources/chapters/utilities.rst.txt +13 -0
  29. amps-python-client-5.3.4.1/docs/command-reference/html/_sources/index.rst.txt +56 -0
  30. amps-python-client-5.3.4.1/docs/command-reference/html/_static/ajax-loader.gif +0 -0
  31. amps-python-client-5.3.4.1/docs/command-reference/html/_static/alabaster.css +699 -0
  32. amps-python-client-5.3.4.1/docs/command-reference/html/_static/basic.css +632 -0
  33. amps-python-client-5.3.4.1/docs/command-reference/html/_static/comment-bright.png +0 -0
  34. amps-python-client-5.3.4.1/docs/command-reference/html/_static/comment-close.png +0 -0
  35. amps-python-client-5.3.4.1/docs/command-reference/html/_static/comment.png +0 -0
  36. amps-python-client-5.3.4.1/docs/command-reference/html/_static/custom.css +192 -0
  37. amps-python-client-5.3.4.1/docs/command-reference/html/_static/custom.css.backup +161 -0
  38. amps-python-client-5.3.4.1/docs/command-reference/html/_static/doctools.js +287 -0
  39. amps-python-client-5.3.4.1/docs/command-reference/html/_static/down-pressed.png +0 -0
  40. amps-python-client-5.3.4.1/docs/command-reference/html/_static/down.png +0 -0
  41. amps-python-client-5.3.4.1/docs/command-reference/html/_static/file.png +0 -0
  42. amps-python-client-5.3.4.1/docs/command-reference/html/_static/flag_logo.png +0 -0
  43. amps-python-client-5.3.4.1/docs/command-reference/html/_static/flag_logo.svg +153 -0
  44. amps-python-client-5.3.4.1/docs/command-reference/html/_static/jquery-3.1.0.js +10074 -0
  45. amps-python-client-5.3.4.1/docs/command-reference/html/_static/jquery.js +4 -0
  46. amps-python-client-5.3.4.1/docs/command-reference/html/_static/minus.png +0 -0
  47. amps-python-client-5.3.4.1/docs/command-reference/html/_static/plus.png +0 -0
  48. amps-python-client-5.3.4.1/docs/command-reference/html/_static/pygments.css +74 -0
  49. amps-python-client-5.3.4.1/docs/command-reference/html/_static/searchtools.js +758 -0
  50. amps-python-client-5.3.4.1/docs/command-reference/html/_static/underscore-1.3.1.js +999 -0
  51. amps-python-client-5.3.4.1/docs/command-reference/html/_static/underscore.js +31 -0
  52. amps-python-client-5.3.4.1/docs/command-reference/html/_static/up-pressed.png +0 -0
  53. amps-python-client-5.3.4.1/docs/command-reference/html/_static/up.png +0 -0
  54. amps-python-client-5.3.4.1/docs/command-reference/html/_static/websupport.js +808 -0
  55. amps-python-client-5.3.4.1/docs/command-reference/html/chapters/ack-messages.html +417 -0
  56. amps-python-client-5.3.4.1/docs/command-reference/html/chapters/content-messages.html +417 -0
  57. amps-python-client-5.3.4.1/docs/command-reference/html/chapters/intro.html +126 -0
  58. amps-python-client-5.3.4.1/docs/command-reference/html/chapters/logon.html +295 -0
  59. amps-python-client-5.3.4.1/docs/command-reference/html/chapters/protocol-reference.html +1190 -0
  60. amps-python-client-5.3.4.1/docs/command-reference/html/chapters/publishing.html +436 -0
  61. amps-python-client-5.3.4.1/docs/command-reference/html/chapters/query-delimiters.html +173 -0
  62. amps-python-client-5.3.4.1/docs/command-reference/html/chapters/query-subscribe.html +2123 -0
  63. amps-python-client-5.3.4.1/docs/command-reference/html/chapters/removing.html +299 -0
  64. amps-python-client-5.3.4.1/docs/command-reference/html/chapters/utilities.html +287 -0
  65. amps-python-client-5.3.4.1/docs/command-reference/html/genindex.html +97 -0
  66. amps-python-client-5.3.4.1/docs/command-reference/html/index.html +138 -0
  67. amps-python-client-5.3.4.1/docs/command-reference/html/objects.inv +0 -0
  68. amps-python-client-5.3.4.1/docs/command-reference/html/search.html +107 -0
  69. amps-python-client-5.3.4.1/docs/command-reference/html/searchindex.js +1 -0
  70. amps-python-client-5.3.4.1/docs/html/.buildinfo +4 -0
  71. amps-python-client-5.3.4.1/docs/html/_sources/code.rst.txt +6 -0
  72. amps-python-client-5.3.4.1/docs/html/_sources/index.rst.txt +29 -0
  73. amps-python-client-5.3.4.1/docs/html/_static/ajax-loader.gif +0 -0
  74. amps-python-client-5.3.4.1/docs/html/_static/basic.css +632 -0
  75. amps-python-client-5.3.4.1/docs/html/_static/classic.css +261 -0
  76. amps-python-client-5.3.4.1/docs/html/_static/comment-bright.png +0 -0
  77. amps-python-client-5.3.4.1/docs/html/_static/comment-close.png +0 -0
  78. amps-python-client-5.3.4.1/docs/html/_static/comment.png +0 -0
  79. amps-python-client-5.3.4.1/docs/html/_static/default.css +1 -0
  80. amps-python-client-5.3.4.1/docs/html/_static/doctools.js +287 -0
  81. amps-python-client-5.3.4.1/docs/html/_static/down-pressed.png +0 -0
  82. amps-python-client-5.3.4.1/docs/html/_static/down.png +0 -0
  83. amps-python-client-5.3.4.1/docs/html/_static/file.png +0 -0
  84. amps-python-client-5.3.4.1/docs/html/_static/jquery-3.1.0.js +10074 -0
  85. amps-python-client-5.3.4.1/docs/html/_static/jquery.js +4 -0
  86. amps-python-client-5.3.4.1/docs/html/_static/minus.png +0 -0
  87. amps-python-client-5.3.4.1/docs/html/_static/plus.png +0 -0
  88. amps-python-client-5.3.4.1/docs/html/_static/pygments.css +74 -0
  89. amps-python-client-5.3.4.1/docs/html/_static/searchtools.js +758 -0
  90. amps-python-client-5.3.4.1/docs/html/_static/sidebar.js +159 -0
  91. amps-python-client-5.3.4.1/docs/html/_static/underscore-1.3.1.js +999 -0
  92. amps-python-client-5.3.4.1/docs/html/_static/underscore.js +31 -0
  93. amps-python-client-5.3.4.1/docs/html/_static/up-pressed.png +0 -0
  94. amps-python-client-5.3.4.1/docs/html/_static/up.png +0 -0
  95. amps-python-client-5.3.4.1/docs/html/_static/websupport.js +808 -0
  96. amps-python-client-5.3.4.1/docs/html/code.html +6503 -0
  97. amps-python-client-5.3.4.1/docs/html/genindex.html +1361 -0
  98. amps-python-client-5.3.4.1/docs/html/index.html +131 -0
  99. amps-python-client-5.3.4.1/docs/html/objects.inv +0 -0
  100. amps-python-client-5.3.4.1/docs/html/py-modindex.html +111 -0
  101. amps-python-client-5.3.4.1/docs/html/search.html +107 -0
  102. amps-python-client-5.3.4.1/docs/html/searchindex.js +1 -0
  103. amps-python-client-5.3.4.1/docs/python/doctrees/chapters/advanced-topics.doctree +0 -0
  104. amps-python-client-5.3.4.1/docs/python/doctrees/chapters/cpp-compiler-list.doctree +0 -0
  105. amps-python-client-5.3.4.1/docs/python/doctrees/chapters/cpp-feature-table.doctree +0 -0
  106. amps-python-client-5.3.4.1/docs/python/doctrees/chapters/creating-commands.doctree +0 -0
  107. amps-python-client-5.3.4.1/docs/python/doctrees/chapters/deltas.doctree +0 -0
  108. amps-python-client-5.3.4.1/docs/python/doctrees/chapters/error-handling.doctree +0 -0
  109. amps-python-client-5.3.4.1/docs/python/doctrees/chapters/exceptions.doctree +0 -0
  110. amps-python-client-5.3.4.1/docs/python/doctrees/chapters/first-program.doctree +0 -0
  111. amps-python-client-5.3.4.1/docs/python/doctrees/chapters/high-availability.doctree +0 -0
  112. amps-python-client-5.3.4.1/docs/python/doctrees/chapters/installing.doctree +0 -0
  113. amps-python-client-5.3.4.1/docs/python/doctrees/chapters/introduction.doctree +0 -0
  114. amps-python-client-5.3.4.1/docs/python/doctrees/chapters/moving-from-python-lite.doctree +0 -0
  115. amps-python-client-5.3.4.1/docs/python/doctrees/chapters/performance-tips.doctree +0 -0
  116. amps-python-client-5.3.4.1/docs/python/doctrees/chapters/queues.doctree +0 -0
  117. amps-python-client-5.3.4.1/docs/python/doctrees/chapters/sow.doctree +0 -0
  118. amps-python-client-5.3.4.1/docs/python/doctrees/chapters/subscriptions.doctree +0 -0
  119. amps-python-client-5.3.4.1/docs/python/doctrees/chapters/utilities.doctree +0 -0
  120. amps-python-client-5.3.4.1/docs/python/doctrees/environment.pickle +0 -0
  121. amps-python-client-5.3.4.1/docs/python/doctrees/index.doctree +0 -0
  122. amps-python-client-5.3.4.1/docs/python/html/.buildinfo +4 -0
  123. amps-python-client-5.3.4.1/docs/python/html/_images/caution.png +0 -0
  124. amps-python-client-5.3.4.1/docs/python/html/_images/caution.svg +25 -0
  125. amps-python-client-5.3.4.1/docs/python/html/_images/connection_string.svg +461 -0
  126. amps-python-client-5.3.4.1/docs/python/html/_images/important.png +0 -0
  127. amps-python-client-5.3.4.1/docs/python/html/_images/important.svg +25 -0
  128. amps-python-client-5.3.4.1/docs/python/html/_images/tip.png +0 -0
  129. amps-python-client-5.3.4.1/docs/python/html/_images/tip.svg +31 -0
  130. amps-python-client-5.3.4.1/docs/python/html/_images/warning.png +0 -0
  131. amps-python-client-5.3.4.1/docs/python/html/_sources/chapters/advanced-topics.rst.txt +398 -0
  132. amps-python-client-5.3.4.1/docs/python/html/_sources/chapters/cpp-compiler-list.rst.txt +6 -0
  133. amps-python-client-5.3.4.1/docs/python/html/_sources/chapters/cpp-feature-table.rst.txt +26 -0
  134. amps-python-client-5.3.4.1/docs/python/html/_sources/chapters/creating-commands.rst.txt +159 -0
  135. amps-python-client-5.3.4.1/docs/python/html/_sources/chapters/deltas.rst.txt +79 -0
  136. amps-python-client-5.3.4.1/docs/python/html/_sources/chapters/error-handling.rst.txt +482 -0
  137. amps-python-client-5.3.4.1/docs/python/html/_sources/chapters/exceptions.rst.txt +128 -0
  138. amps-python-client-5.3.4.1/docs/python/html/_sources/chapters/first-program.rst.txt +142 -0
  139. amps-python-client-5.3.4.1/docs/python/html/_sources/chapters/high-availability.rst.txt +876 -0
  140. amps-python-client-5.3.4.1/docs/python/html/_sources/chapters/installing.rst.txt +184 -0
  141. amps-python-client-5.3.4.1/docs/python/html/_sources/chapters/introduction.rst.txt +50 -0
  142. amps-python-client-5.3.4.1/docs/python/html/_sources/chapters/moving-from-python-lite.rst.txt +32 -0
  143. amps-python-client-5.3.4.1/docs/python/html/_sources/chapters/performance-tips.rst.txt +434 -0
  144. amps-python-client-5.3.4.1/docs/python/html/_sources/chapters/queues.rst.txt +282 -0
  145. amps-python-client-5.3.4.1/docs/python/html/_sources/chapters/sow.rst.txt +292 -0
  146. amps-python-client-5.3.4.1/docs/python/html/_sources/chapters/subscriptions.rst.txt +374 -0
  147. amps-python-client-5.3.4.1/docs/python/html/_sources/chapters/utilities.rst.txt +214 -0
  148. amps-python-client-5.3.4.1/docs/python/html/_sources/index.rst.txt +44 -0
  149. amps-python-client-5.3.4.1/docs/python/html/_static/ajax-loader.gif +0 -0
  150. amps-python-client-5.3.4.1/docs/python/html/_static/alabaster.css +699 -0
  151. amps-python-client-5.3.4.1/docs/python/html/_static/basic.css +632 -0
  152. amps-python-client-5.3.4.1/docs/python/html/_static/comment-bright.png +0 -0
  153. amps-python-client-5.3.4.1/docs/python/html/_static/comment-close.png +0 -0
  154. amps-python-client-5.3.4.1/docs/python/html/_static/comment.png +0 -0
  155. amps-python-client-5.3.4.1/docs/python/html/_static/custom.css +192 -0
  156. amps-python-client-5.3.4.1/docs/python/html/_static/custom.css.backup +161 -0
  157. amps-python-client-5.3.4.1/docs/python/html/_static/doctools.js +287 -0
  158. amps-python-client-5.3.4.1/docs/python/html/_static/down-pressed.png +0 -0
  159. amps-python-client-5.3.4.1/docs/python/html/_static/down.png +0 -0
  160. amps-python-client-5.3.4.1/docs/python/html/_static/file.png +0 -0
  161. amps-python-client-5.3.4.1/docs/python/html/_static/flag_logo.png +0 -0
  162. amps-python-client-5.3.4.1/docs/python/html/_static/flag_logo.svg +153 -0
  163. amps-python-client-5.3.4.1/docs/python/html/_static/jquery-3.1.0.js +10074 -0
  164. amps-python-client-5.3.4.1/docs/python/html/_static/jquery.js +4 -0
  165. amps-python-client-5.3.4.1/docs/python/html/_static/minus.png +0 -0
  166. amps-python-client-5.3.4.1/docs/python/html/_static/plus.png +0 -0
  167. amps-python-client-5.3.4.1/docs/python/html/_static/pygments.css +74 -0
  168. amps-python-client-5.3.4.1/docs/python/html/_static/searchtools.js +758 -0
  169. amps-python-client-5.3.4.1/docs/python/html/_static/underscore-1.3.1.js +999 -0
  170. amps-python-client-5.3.4.1/docs/python/html/_static/underscore.js +31 -0
  171. amps-python-client-5.3.4.1/docs/python/html/_static/up-pressed.png +0 -0
  172. amps-python-client-5.3.4.1/docs/python/html/_static/up.png +0 -0
  173. amps-python-client-5.3.4.1/docs/python/html/_static/websupport.js +808 -0
  174. amps-python-client-5.3.4.1/docs/python/html/chapters/advanced-topics.html +447 -0
  175. amps-python-client-5.3.4.1/docs/python/html/chapters/cpp-compiler-list.html +92 -0
  176. amps-python-client-5.3.4.1/docs/python/html/chapters/cpp-feature-table.html +156 -0
  177. amps-python-client-5.3.4.1/docs/python/html/chapters/creating-commands.html +2837 -0
  178. amps-python-client-5.3.4.1/docs/python/html/chapters/deltas.html +169 -0
  179. amps-python-client-5.3.4.1/docs/python/html/chapters/error-handling.html +746 -0
  180. amps-python-client-5.3.4.1/docs/python/html/chapters/exceptions.html +272 -0
  181. amps-python-client-5.3.4.1/docs/python/html/chapters/first-program.html +499 -0
  182. amps-python-client-5.3.4.1/docs/python/html/chapters/high-availability.html +1014 -0
  183. amps-python-client-5.3.4.1/docs/python/html/chapters/installing.html +264 -0
  184. amps-python-client-5.3.4.1/docs/python/html/chapters/introduction.html +245 -0
  185. amps-python-client-5.3.4.1/docs/python/html/chapters/moving-from-python-lite.html +118 -0
  186. amps-python-client-5.3.4.1/docs/python/html/chapters/performance-tips.html +499 -0
  187. amps-python-client-5.3.4.1/docs/python/html/chapters/queues.html +352 -0
  188. amps-python-client-5.3.4.1/docs/python/html/chapters/sow.html +381 -0
  189. amps-python-client-5.3.4.1/docs/python/html/chapters/subscriptions.html +535 -0
  190. amps-python-client-5.3.4.1/docs/python/html/chapters/utilities.html +302 -0
  191. amps-python-client-5.3.4.1/docs/python/html/genindex.html +351 -0
  192. amps-python-client-5.3.4.1/docs/python/html/index.html +380 -0
  193. amps-python-client-5.3.4.1/docs/python/html/objects.inv +0 -0
  194. amps-python-client-5.3.4.1/docs/python/html/search.html +107 -0
  195. amps-python-client-5.3.4.1/docs/python/html/searchindex.js +1 -0
  196. amps-python-client-5.3.4.1/docs/python-quickstart/doctrees/chapters/crankitup.doctree +0 -0
  197. amps-python-client-5.3.4.1/docs/python-quickstart/doctrees/chapters/equipment.doctree +0 -0
  198. amps-python-client-5.3.4.1/docs/python-quickstart/doctrees/environment.pickle +0 -0
  199. amps-python-client-5.3.4.1/docs/python-quickstart/doctrees/index.doctree +0 -0
  200. amps-python-client-5.3.4.1/docs/python-quickstart/html/.buildinfo +4 -0
  201. amps-python-client-5.3.4.1/docs/python-quickstart/html/_sources/chapters/crankitup.rst.txt +155 -0
  202. amps-python-client-5.3.4.1/docs/python-quickstart/html/_sources/chapters/equipment.rst.txt +19 -0
  203. amps-python-client-5.3.4.1/docs/python-quickstart/html/_sources/index.rst.txt +20 -0
  204. amps-python-client-5.3.4.1/docs/python-quickstart/html/_static/ajax-loader.gif +0 -0
  205. amps-python-client-5.3.4.1/docs/python-quickstart/html/_static/alabaster.css +699 -0
  206. amps-python-client-5.3.4.1/docs/python-quickstart/html/_static/basic.css +632 -0
  207. amps-python-client-5.3.4.1/docs/python-quickstart/html/_static/comment-bright.png +0 -0
  208. amps-python-client-5.3.4.1/docs/python-quickstart/html/_static/comment-close.png +0 -0
  209. amps-python-client-5.3.4.1/docs/python-quickstart/html/_static/comment.png +0 -0
  210. amps-python-client-5.3.4.1/docs/python-quickstart/html/_static/custom.css +192 -0
  211. amps-python-client-5.3.4.1/docs/python-quickstart/html/_static/custom.css.backup +161 -0
  212. amps-python-client-5.3.4.1/docs/python-quickstart/html/_static/doctools.js +287 -0
  213. amps-python-client-5.3.4.1/docs/python-quickstart/html/_static/down-pressed.png +0 -0
  214. amps-python-client-5.3.4.1/docs/python-quickstart/html/_static/down.png +0 -0
  215. amps-python-client-5.3.4.1/docs/python-quickstart/html/_static/file.png +0 -0
  216. amps-python-client-5.3.4.1/docs/python-quickstart/html/_static/flag_logo.png +0 -0
  217. amps-python-client-5.3.4.1/docs/python-quickstart/html/_static/flag_logo.svg +153 -0
  218. amps-python-client-5.3.4.1/docs/python-quickstart/html/_static/jquery-3.1.0.js +10074 -0
  219. amps-python-client-5.3.4.1/docs/python-quickstart/html/_static/jquery.js +4 -0
  220. amps-python-client-5.3.4.1/docs/python-quickstart/html/_static/minus.png +0 -0
  221. amps-python-client-5.3.4.1/docs/python-quickstart/html/_static/plus.png +0 -0
  222. amps-python-client-5.3.4.1/docs/python-quickstart/html/_static/pygments.css +74 -0
  223. amps-python-client-5.3.4.1/docs/python-quickstart/html/_static/searchtools.js +758 -0
  224. amps-python-client-5.3.4.1/docs/python-quickstart/html/_static/underscore-1.3.1.js +999 -0
  225. amps-python-client-5.3.4.1/docs/python-quickstart/html/_static/underscore.js +31 -0
  226. amps-python-client-5.3.4.1/docs/python-quickstart/html/_static/up-pressed.png +0 -0
  227. amps-python-client-5.3.4.1/docs/python-quickstart/html/_static/up.png +0 -0
  228. amps-python-client-5.3.4.1/docs/python-quickstart/html/_static/websupport.js +808 -0
  229. amps-python-client-5.3.4.1/docs/python-quickstart/html/chapters/crankitup.html +271 -0
  230. amps-python-client-5.3.4.1/docs/python-quickstart/html/chapters/equipment.html +105 -0
  231. amps-python-client-5.3.4.1/docs/python-quickstart/html/genindex.html +97 -0
  232. amps-python-client-5.3.4.1/docs/python-quickstart/html/index.html +382 -0
  233. amps-python-client-5.3.4.1/docs/python-quickstart/html/objects.inv +0 -0
  234. amps-python-client-5.3.4.1/docs/python-quickstart/html/search.html +107 -0
  235. amps-python-client-5.3.4.1/docs/python-quickstart/html/searchindex.js +1 -0
  236. amps-python-client-5.3.4.1/docs/resources/custom.css +9 -0
  237. amps-python-client-5.3.4.1/docs/resources/flag_logo.svg +153 -0
  238. amps-python-client-5.3.4.1/docs/user-guide/doctrees/chapters/acks.doctree +0 -0
  239. amps-python-client-5.3.4.1/docs/user-guide/doctrees/chapters/actions.doctree +0 -0
  240. amps-python-client-5.3.4.1/docs/user-guide/doctrees/chapters/amps-statistics.doctree +0 -0
  241. amps-python-client-5.3.4.1/docs/user-guide/doctrees/chapters/amps_expressions.doctree +0 -0
  242. amps-python-client-5.3.4.1/docs/user-guide/doctrees/chapters/amps_functions.doctree +0 -0
  243. amps-python-client-5.3.4.1/docs/user-guide/doctrees/chapters/auxiliary_modules.doctree +0 -0
  244. amps-python-client-5.3.4.1/docs/user-guide/doctrees/chapters/config-file-shortcuts.doctree +0 -0
  245. amps-python-client-5.3.4.1/docs/user-guide/doctrees/chapters/conflated_topics.doctree +0 -0
  246. amps-python-client-5.3.4.1/docs/user-guide/doctrees/chapters/constructing-fields.doctree +0 -0
  247. amps-python-client-5.3.4.1/docs/user-guide/doctrees/chapters/daemon.doctree +0 -0
  248. amps-python-client-5.3.4.1/docs/user-guide/doctrees/chapters/delta.doctree +0 -0
  249. amps-python-client-5.3.4.1/docs/user-guide/doctrees/chapters/distribution.doctree +0 -0
  250. amps-python-client-5.3.4.1/docs/user-guide/doctrees/chapters/enrichment.doctree +0 -0
  251. amps-python-client-5.3.4.1/docs/user-guide/doctrees/chapters/events.doctree +0 -0
  252. amps-python-client-5.3.4.1/docs/user-guide/doctrees/chapters/file_format_versions.doctree +0 -0
  253. amps-python-client-5.3.4.1/docs/user-guide/doctrees/chapters/glossary.doctree +0 -0
  254. amps-python-client-5.3.4.1/docs/user-guide/doctrees/chapters/ha.doctree +0 -0
  255. amps-python-client-5.3.4.1/docs/user-guide/doctrees/chapters/installing_and_starting.doctree +0 -0
  256. amps-python-client-5.3.4.1/docs/user-guide/doctrees/chapters/intro.doctree +0 -0
  257. amps-python-client-5.3.4.1/docs/user-guide/doctrees/chapters/logging.doctree +0 -0
  258. amps-python-client-5.3.4.1/docs/user-guide/doctrees/chapters/messageTypes.doctree +0 -0
  259. amps-python-client-5.3.4.1/docs/user-guide/doctrees/chapters/monitoring.doctree +0 -0
  260. amps-python-client-5.3.4.1/docs/user-guide/doctrees/chapters/oof.doctree +0 -0
  261. amps-python-client-5.3.4.1/docs/user-guide/doctrees/chapters/operation.doctree +0 -0
  262. amps-python-client-5.3.4.1/docs/user-guide/doctrees/chapters/pub_sub.doctree +0 -0
  263. amps-python-client-5.3.4.1/docs/user-guide/doctrees/chapters/queues.doctree +0 -0
  264. amps-python-client-5.3.4.1/docs/user-guide/doctrees/chapters/replication.doctree +0 -0
  265. amps-python-client-5.3.4.1/docs/user-guide/doctrees/chapters/securing.doctree +0 -0
  266. amps-python-client-5.3.4.1/docs/user-guide/doctrees/chapters/sow.doctree +0 -0
  267. amps-python-client-5.3.4.1/docs/user-guide/doctrees/chapters/sow_queries.doctree +0 -0
  268. amps-python-client-5.3.4.1/docs/user-guide/doctrees/chapters/spark.doctree +0 -0
  269. amps-python-client-5.3.4.1/docs/user-guide/doctrees/chapters/transports.doctree +0 -0
  270. amps-python-client-5.3.4.1/docs/user-guide/doctrees/chapters/troubleshooting.doctree +0 -0
  271. amps-python-client-5.3.4.1/docs/user-guide/doctrees/chapters/txlog.doctree +0 -0
  272. amps-python-client-5.3.4.1/docs/user-guide/doctrees/chapters/usecases.doctree +0 -0
  273. amps-python-client-5.3.4.1/docs/user-guide/doctrees/chapters/utilities.doctree +0 -0
  274. amps-python-client-5.3.4.1/docs/user-guide/doctrees/chapters/views.doctree +0 -0
  275. amps-python-client-5.3.4.1/docs/user-guide/doctrees/environment.pickle +0 -0
  276. amps-python-client-5.3.4.1/docs/user-guide/doctrees/index.doctree +0 -0
  277. amps-python-client-5.3.4.1/docs/user-guide/html/.buildinfo +4 -0
  278. amps-python-client-5.3.4.1/docs/user-guide/html/_images/AMPS-Queues-Intro.svg +1330 -0
  279. amps-python-client-5.3.4.1/docs/user-guide/html/_images/GeoRepl.png +0 -0
  280. amps-python-client-5.3.4.1/docs/user-guide/html/_images/HA_async_ack.png +0 -0
  281. amps-python-client-5.3.4.1/docs/user-guide/html/_images/HA_sync_ack.png +0 -0
  282. amps-python-client-5.3.4.1/docs/user-guide/html/_images/Hot-Hot-Replication.png +0 -0
  283. amps-python-client-5.3.4.1/docs/user-guide/html/_images/MessageOrdering.svg +235 -0
  284. amps-python-client-5.3.4.1/docs/user-guide/html/_images/OOF5.png +0 -0
  285. amps-python-client-5.3.4.1/docs/user-guide/html/_images/OOF6.png +0 -0
  286. amps-python-client-5.3.4.1/docs/user-guide/html/_images/OOF7.png +0 -0
  287. amps-python-client-5.3.4.1/docs/user-guide/html/_images/OOF8.png +0 -0
  288. amps-python-client-5.3.4.1/docs/user-guide/html/_images/PubSub1.svg +1 -0
  289. amps-python-client-5.3.4.1/docs/user-guide/html/_images/PubSub2.svg +1 -0
  290. amps-python-client-5.3.4.1/docs/user-guide/html/_images/SOWAndSubscribeAndReplace.svg +684 -0
  291. amps-python-client-5.3.4.1/docs/user-guide/html/_images/SOWQuery1.svg +402 -0
  292. amps-python-client-5.3.4.1/docs/user-guide/html/_images/SOWQuery2.svg +505 -0
  293. amps-python-client-5.3.4.1/docs/user-guide/html/_images/UseCaseFig1.svg +1 -0
  294. amps-python-client-5.3.4.1/docs/user-guide/html/_images/UseCaseFig2.svg +1 -0
  295. amps-python-client-5.3.4.1/docs/user-guide/html/_images/UseCaseFig3.svg +1 -0
  296. amps-python-client-5.3.4.1/docs/user-guide/html/_images/UseCaseFig4.svg +1 -0
  297. amps-python-client-5.3.4.1/docs/user-guide/html/_images/caution.png +0 -0
  298. amps-python-client-5.3.4.1/docs/user-guide/html/_images/caution.svg +25 -0
  299. amps-python-client-5.3.4.1/docs/user-guide/html/_images/chicago_group.png +0 -0
  300. amps-python-client-5.3.4.1/docs/user-guide/html/_images/delta_original_messages.png +0 -0
  301. amps-python-client-5.3.4.1/docs/user-guide/html/_images/delta_update_message.png +0 -0
  302. amps-python-client-5.3.4.1/docs/user-guide/html/_images/important.png +0 -0
  303. amps-python-client-5.3.4.1/docs/user-guide/html/_images/important.svg +25 -0
  304. amps-python-client-5.3.4.1/docs/user-guide/html/_images/inline_view_conflation.svg +1 -0
  305. amps-python-client-5.3.4.1/docs/user-guide/html/_images/paginated_subs_pub.png +0 -0
  306. amps-python-client-5.3.4.1/docs/user-guide/html/_images/paginated_subs_sub.png +0 -0
  307. amps-python-client-5.3.4.1/docs/user-guide/html/_images/queue_usage_overview.svg +627 -0
  308. amps-python-client-5.3.4.1/docs/user-guide/html/_images/replication_hub.png +0 -0
  309. amps-python-client-5.3.4.1/docs/user-guide/html/_images/replication_scenario_with_ha.png +0 -0
  310. amps-python-client-5.3.4.1/docs/user-guide/html/_images/sow_overview_1.svg +248 -0
  311. amps-python-client-5.3.4.1/docs/user-guide/html/_images/sow_overview_2.svg +183 -0
  312. amps-python-client-5.3.4.1/docs/user-guide/html/_images/sow_update_sequence.svg +1 -0
  313. amps-python-client-5.3.4.1/docs/user-guide/html/_images/tip.png +0 -0
  314. amps-python-client-5.3.4.1/docs/user-guide/html/_images/tip.svg +31 -0
  315. amps-python-client-5.3.4.1/docs/user-guide/html/_images/warning.png +0 -0
  316. amps-python-client-5.3.4.1/docs/user-guide/html/_images/warning.svg +23 -0
  317. amps-python-client-5.3.4.1/docs/user-guide/html/_sources/chapters/acks.rst.txt +232 -0
  318. amps-python-client-5.3.4.1/docs/user-guide/html/_sources/chapters/actions.rst.txt +111 -0
  319. amps-python-client-5.3.4.1/docs/user-guide/html/_sources/chapters/amps-statistics.rst.txt +358 -0
  320. amps-python-client-5.3.4.1/docs/user-guide/html/_sources/chapters/amps_expressions.rst.txt +83 -0
  321. amps-python-client-5.3.4.1/docs/user-guide/html/_sources/chapters/amps_functions.rst.txt +11 -0
  322. amps-python-client-5.3.4.1/docs/user-guide/html/_sources/chapters/auxiliary_modules.rst.txt +86 -0
  323. amps-python-client-5.3.4.1/docs/user-guide/html/_sources/chapters/config-file-shortcuts.rst.txt +9 -0
  324. amps-python-client-5.3.4.1/docs/user-guide/html/_sources/chapters/conflated_topics.rst.txt +111 -0
  325. amps-python-client-5.3.4.1/docs/user-guide/html/_sources/chapters/constructing-fields.rst.txt +269 -0
  326. amps-python-client-5.3.4.1/docs/user-guide/html/_sources/chapters/daemon.rst.txt +232 -0
  327. amps-python-client-5.3.4.1/docs/user-guide/html/_sources/chapters/delta.rst.txt +556 -0
  328. amps-python-client-5.3.4.1/docs/user-guide/html/_sources/chapters/distribution.rst.txt +186 -0
  329. amps-python-client-5.3.4.1/docs/user-guide/html/_sources/chapters/enrichment.rst.txt +191 -0
  330. amps-python-client-5.3.4.1/docs/user-guide/html/_sources/chapters/events.rst.txt +39 -0
  331. amps-python-client-5.3.4.1/docs/user-guide/html/_sources/chapters/file_format_versions.rst.txt +203 -0
  332. amps-python-client-5.3.4.1/docs/user-guide/html/_sources/chapters/glossary.rst.txt +101 -0
  333. amps-python-client-5.3.4.1/docs/user-guide/html/_sources/chapters/ha.rst.txt +465 -0
  334. amps-python-client-5.3.4.1/docs/user-guide/html/_sources/chapters/installing_and_starting.rst.txt +23 -0
  335. amps-python-client-5.3.4.1/docs/user-guide/html/_sources/chapters/intro.rst.txt +116 -0
  336. amps-python-client-5.3.4.1/docs/user-guide/html/_sources/chapters/logging.rst.txt +34 -0
  337. amps-python-client-5.3.4.1/docs/user-guide/html/_sources/chapters/messageTypes.rst.txt +1398 -0
  338. amps-python-client-5.3.4.1/docs/user-guide/html/_sources/chapters/monitoring.rst.txt +326 -0
  339. amps-python-client-5.3.4.1/docs/user-guide/html/_sources/chapters/oof.rst.txt +312 -0
  340. amps-python-client-5.3.4.1/docs/user-guide/html/_sources/chapters/operation.rst.txt +27 -0
  341. amps-python-client-5.3.4.1/docs/user-guide/html/_sources/chapters/pub_sub.rst.txt +49 -0
  342. amps-python-client-5.3.4.1/docs/user-guide/html/_sources/chapters/queues.rst.txt +1351 -0
  343. amps-python-client-5.3.4.1/docs/user-guide/html/_sources/chapters/replication.rst.txt +1228 -0
  344. amps-python-client-5.3.4.1/docs/user-guide/html/_sources/chapters/securing.rst.txt +657 -0
  345. amps-python-client-5.3.4.1/docs/user-guide/html/_sources/chapters/sow.rst.txt +57 -0
  346. amps-python-client-5.3.4.1/docs/user-guide/html/_sources/chapters/sow_queries.rst.txt +25 -0
  347. amps-python-client-5.3.4.1/docs/user-guide/html/_sources/chapters/spark.rst.txt +824 -0
  348. amps-python-client-5.3.4.1/docs/user-guide/html/_sources/chapters/transports.rst.txt +291 -0
  349. amps-python-client-5.3.4.1/docs/user-guide/html/_sources/chapters/troubleshooting.rst.txt +517 -0
  350. amps-python-client-5.3.4.1/docs/user-guide/html/_sources/chapters/txlog.rst.txt +62 -0
  351. amps-python-client-5.3.4.1/docs/user-guide/html/_sources/chapters/usecases.rst.txt +21 -0
  352. amps-python-client-5.3.4.1/docs/user-guide/html/_sources/chapters/utilities.rst.txt +62 -0
  353. amps-python-client-5.3.4.1/docs/user-guide/html/_sources/chapters/views.rst.txt +175 -0
  354. amps-python-client-5.3.4.1/docs/user-guide/html/_sources/index.rst.txt +110 -0
  355. amps-python-client-5.3.4.1/docs/user-guide/html/_static/ajax-loader.gif +0 -0
  356. amps-python-client-5.3.4.1/docs/user-guide/html/_static/alabaster.css +695 -0
  357. amps-python-client-5.3.4.1/docs/user-guide/html/_static/basic.css +632 -0
  358. amps-python-client-5.3.4.1/docs/user-guide/html/_static/comment-bright.png +0 -0
  359. amps-python-client-5.3.4.1/docs/user-guide/html/_static/comment-close.png +0 -0
  360. amps-python-client-5.3.4.1/docs/user-guide/html/_static/comment.png +0 -0
  361. amps-python-client-5.3.4.1/docs/user-guide/html/_static/custom.css +192 -0
  362. amps-python-client-5.3.4.1/docs/user-guide/html/_static/custom.css.backup +161 -0
  363. amps-python-client-5.3.4.1/docs/user-guide/html/_static/doctools.js +287 -0
  364. amps-python-client-5.3.4.1/docs/user-guide/html/_static/down-pressed.png +0 -0
  365. amps-python-client-5.3.4.1/docs/user-guide/html/_static/down.png +0 -0
  366. amps-python-client-5.3.4.1/docs/user-guide/html/_static/file.png +0 -0
  367. amps-python-client-5.3.4.1/docs/user-guide/html/_static/flag_logo.png +0 -0
  368. amps-python-client-5.3.4.1/docs/user-guide/html/_static/flag_logo.svg +153 -0
  369. amps-python-client-5.3.4.1/docs/user-guide/html/_static/jquery-3.1.0.js +10074 -0
  370. amps-python-client-5.3.4.1/docs/user-guide/html/_static/jquery.js +4 -0
  371. amps-python-client-5.3.4.1/docs/user-guide/html/_static/minus.png +0 -0
  372. amps-python-client-5.3.4.1/docs/user-guide/html/_static/plus.png +0 -0
  373. amps-python-client-5.3.4.1/docs/user-guide/html/_static/pygments.css +74 -0
  374. amps-python-client-5.3.4.1/docs/user-guide/html/_static/searchtools.js +758 -0
  375. amps-python-client-5.3.4.1/docs/user-guide/html/_static/underscore-1.3.1.js +999 -0
  376. amps-python-client-5.3.4.1/docs/user-guide/html/_static/underscore.js +31 -0
  377. amps-python-client-5.3.4.1/docs/user-guide/html/_static/up-pressed.png +0 -0
  378. amps-python-client-5.3.4.1/docs/user-guide/html/_static/up.png +0 -0
  379. amps-python-client-5.3.4.1/docs/user-guide/html/_static/websupport.js +808 -0
  380. amps-python-client-5.3.4.1/docs/user-guide/html/chapters/acks.html +289 -0
  381. amps-python-client-5.3.4.1/docs/user-guide/html/chapters/actions.html +3782 -0
  382. amps-python-client-5.3.4.1/docs/user-guide/html/chapters/amps-statistics.html +439 -0
  383. amps-python-client-5.3.4.1/docs/user-guide/html/chapters/amps_expressions.html +1552 -0
  384. amps-python-client-5.3.4.1/docs/user-guide/html/chapters/amps_functions.html +1626 -0
  385. amps-python-client-5.3.4.1/docs/user-guide/html/chapters/auxiliary_modules.html +2548 -0
  386. amps-python-client-5.3.4.1/docs/user-guide/html/chapters/config-file-shortcuts.html +508 -0
  387. amps-python-client-5.3.4.1/docs/user-guide/html/chapters/conflated_topics.html +328 -0
  388. amps-python-client-5.3.4.1/docs/user-guide/html/chapters/constructing-fields.html +447 -0
  389. amps-python-client-5.3.4.1/docs/user-guide/html/chapters/daemon.html +295 -0
  390. amps-python-client-5.3.4.1/docs/user-guide/html/chapters/delta.html +609 -0
  391. amps-python-client-5.3.4.1/docs/user-guide/html/chapters/distribution.html +246 -0
  392. amps-python-client-5.3.4.1/docs/user-guide/html/chapters/enrichment.html +264 -0
  393. amps-python-client-5.3.4.1/docs/user-guide/html/chapters/events.html +449 -0
  394. amps-python-client-5.3.4.1/docs/user-guide/html/chapters/file_format_versions.html +229 -0
  395. amps-python-client-5.3.4.1/docs/user-guide/html/chapters/glossary.html +215 -0
  396. amps-python-client-5.3.4.1/docs/user-guide/html/chapters/ha.html +978 -0
  397. amps-python-client-5.3.4.1/docs/user-guide/html/chapters/installing_and_starting.html +357 -0
  398. amps-python-client-5.3.4.1/docs/user-guide/html/chapters/intro.html +572 -0
  399. amps-python-client-5.3.4.1/docs/user-guide/html/chapters/logging.html +972 -0
  400. amps-python-client-5.3.4.1/docs/user-guide/html/chapters/messageTypes.html +1280 -0
  401. amps-python-client-5.3.4.1/docs/user-guide/html/chapters/monitoring.html +718 -0
  402. amps-python-client-5.3.4.1/docs/user-guide/html/chapters/oof.html +341 -0
  403. amps-python-client-5.3.4.1/docs/user-guide/html/chapters/operation.html +1515 -0
  404. amps-python-client-5.3.4.1/docs/user-guide/html/chapters/pub_sub.html +934 -0
  405. amps-python-client-5.3.4.1/docs/user-guide/html/chapters/queues.html +1767 -0
  406. amps-python-client-5.3.4.1/docs/user-guide/html/chapters/replication.html +1777 -0
  407. amps-python-client-5.3.4.1/docs/user-guide/html/chapters/securing.html +697 -0
  408. amps-python-client-5.3.4.1/docs/user-guide/html/chapters/sow.html +1038 -0
  409. amps-python-client-5.3.4.1/docs/user-guide/html/chapters/sow_queries.html +621 -0
  410. amps-python-client-5.3.4.1/docs/user-guide/html/chapters/spark.html +819 -0
  411. amps-python-client-5.3.4.1/docs/user-guide/html/chapters/transports.html +352 -0
  412. amps-python-client-5.3.4.1/docs/user-guide/html/chapters/troubleshooting.html +530 -0
  413. amps-python-client-5.3.4.1/docs/user-guide/html/chapters/txlog.html +1013 -0
  414. amps-python-client-5.3.4.1/docs/user-guide/html/chapters/usecases.html +288 -0
  415. amps-python-client-5.3.4.1/docs/user-guide/html/chapters/utilities.html +133 -0
  416. amps-python-client-5.3.4.1/docs/user-guide/html/chapters/views.html +1120 -0
  417. amps-python-client-5.3.4.1/docs/user-guide/html/genindex.html +1261 -0
  418. amps-python-client-5.3.4.1/docs/user-guide/html/index.html +163 -0
  419. amps-python-client-5.3.4.1/docs/user-guide/html/objects.inv +0 -0
  420. amps-python-client-5.3.4.1/docs/user-guide/html/search.html +106 -0
  421. amps-python-client-5.3.4.1/docs/user-guide/html/searchindex.js +1 -0
  422. amps-python-client-5.3.4.1/include/ampspy_bookmarkstore.hpp +63 -0
  423. amps-python-client-5.3.4.1/include/ampspy_compat.h +63 -0
  424. amps-python-client-5.3.4.1/include/ampspy_defs.hpp +181 -0
  425. amps-python-client-5.3.4.1/include/ampspy_recoverypointadapter.hpp +52 -0
  426. amps-python-client-5.3.4.1/include/ampspy_shims.hpp +113 -0
  427. amps-python-client-5.3.4.1/include/ampspy_type_object.hpp +242 -0
  428. amps-python-client-5.3.4.1/include/ampspy_types.hpp +1139 -0
  429. amps-python-client-5.3.4.1/include/ampspyver.h +30 -0
  430. amps-python-client-5.3.4.1/index.html +66 -0
  431. amps-python-client-5.3.4.1/samples/AMPSConsolePublisher.py +59 -0
  432. amps-python-client-5.3.4.1/samples/AMPSConsoleSubscriber.py +63 -0
  433. amps-python-client-5.3.4.1/samples/AMPSFIXBuilderPublisher.py +71 -0
  434. amps-python-client-5.3.4.1/samples/AMPSFIXShredderSubscriber.py +69 -0
  435. amps-python-client-5.3.4.1/samples/AMPSNVFIXBuilderPublisher.py +71 -0
  436. amps-python-client-5.3.4.1/samples/AMPSNVFIXShredderSubscriber.py +67 -0
  437. amps-python-client-5.3.4.1/samples/AMPSPublishForReplay.py +81 -0
  438. amps-python-client-5.3.4.1/samples/AMPSQueueConsumer.py +69 -0
  439. amps-python-client-5.3.4.1/samples/AMPSQueuePublisher.py +59 -0
  440. amps-python-client-5.3.4.1/samples/AMPSSOWConsolePublisher.py +67 -0
  441. amps-python-client-5.3.4.1/samples/AMPSSOWConsoleSubscriber.py +77 -0
  442. amps-python-client-5.3.4.1/samples/AMPSSOWandSubscribeConsoleSubscriber.py +79 -0
  443. amps-python-client-5.3.4.1/samples/AMPSSOWandSubscribeWithOOF.py +108 -0
  444. amps-python-client-5.3.4.1/samples/AMPSSubscribeForReplay.py +128 -0
  445. amps-python-client-5.3.4.1/samples/AMPSUpdateForOOF.py +123 -0
  446. amps-python-client-5.3.4.1/samples/CompositeMessagePublisher.py +84 -0
  447. amps-python-client-5.3.4.1/samples/CompositeMessageSubscriber.py +87 -0
  448. amps-python-client-5.3.4.1/samples/RandomServerChooser.py +41 -0
  449. amps-python-client-5.3.4.1/samples/sample.xml +335 -0
  450. amps-python-client-5.3.4.1/setup.py +209 -0
  451. amps-python-client-5.3.4.1/setup_amps.py +94 -0
  452. amps-python-client-5.3.4.1/src/ampspy_shims.cpp +203 -0
  453. amps-python-client-5.3.4.1/src/ampspy_type_object.cpp +484 -0
  454. amps-python-client-5.3.4.1/src/authenticator.cpp +128 -0
  455. amps-python-client-5.3.4.1/src/bookmarkstore.cpp +238 -0
  456. amps-python-client-5.3.4.1/src/client.cpp +2430 -0
  457. amps-python-client-5.3.4.1/src/client_docs.h +956 -0
  458. amps-python-client-5.3.4.1/src/cmessagehandler.cpp +151 -0
  459. amps-python-client-5.3.4.1/src/command.cpp +164 -0
  460. amps-python-client-5.3.4.1/src/command_docs.h +194 -0
  461. amps-python-client-5.3.4.1/src/compositemessagebuilder.cpp +111 -0
  462. amps-python-client-5.3.4.1/src/compositemessageparser.cpp +146 -0
  463. amps-python-client-5.3.4.1/src/conflatingrecoverypointadapter.cpp +194 -0
  464. amps-python-client-5.3.4.1/src/cpp/include/amps/BlockPublishStore.hpp +2053 -0
  465. amps-python-client-5.3.4.1/src/cpp/include/amps/BlockStore.hpp +677 -0
  466. amps-python-client-5.3.4.1/src/cpp/include/amps/BookmarkStore.hpp +542 -0
  467. amps-python-client-5.3.4.1/src/cpp/include/amps/Buffer.hpp +214 -0
  468. amps-python-client-5.3.4.1/src/cpp/include/amps/CompositeMessageBuilder.hpp +174 -0
  469. amps-python-client-5.3.4.1/src/cpp/include/amps/CompositeMessageParser.hpp +151 -0
  470. amps-python-client-5.3.4.1/src/cpp/include/amps/DefaultServerChooser.hpp +162 -0
  471. amps-python-client-5.3.4.1/src/cpp/include/amps/Field.hpp +719 -0
  472. amps-python-client-5.3.4.1/src/cpp/include/amps/HAClient.hpp +370 -0
  473. amps-python-client-5.3.4.1/src/cpp/include/amps/HAClientImpl.hpp +460 -0
  474. amps-python-client-5.3.4.1/src/cpp/include/amps/HybridPublishStore.hpp +481 -0
  475. amps-python-client-5.3.4.1/src/cpp/include/amps/LoggedBookmarkStore.hpp +1255 -0
  476. amps-python-client-5.3.4.1/src/cpp/include/amps/MMapBookmarkStore.hpp +1283 -0
  477. amps-python-client-5.3.4.1/src/cpp/include/amps/MMapStoreBuffer.hpp +290 -0
  478. amps-python-client-5.3.4.1/src/cpp/include/amps/MemoryBookmarkStore.hpp +1622 -0
  479. amps-python-client-5.3.4.1/src/cpp/include/amps/MemoryPublishStore.hpp +66 -0
  480. amps-python-client-5.3.4.1/src/cpp/include/amps/MemoryStoreBuffer.hpp +244 -0
  481. amps-python-client-5.3.4.1/src/cpp/include/amps/MemorySubscriptionManager.hpp +850 -0
  482. amps-python-client-5.3.4.1/src/cpp/include/amps/Message.hpp +1819 -0
  483. amps-python-client-5.3.4.1/src/cpp/include/amps/MessageRouter.hpp +618 -0
  484. amps-python-client-5.3.4.1/src/cpp/include/amps/PublishStore.hpp +158 -0
  485. amps-python-client-5.3.4.1/src/cpp/include/amps/ReconnectDelayStrategy.hpp +106 -0
  486. amps-python-client-5.3.4.1/src/cpp/include/amps/ReconnectDelayStrategyImpl.hpp +317 -0
  487. amps-python-client-5.3.4.1/src/cpp/include/amps/RecoveryPoint.hpp +323 -0
  488. amps-python-client-5.3.4.1/src/cpp/include/amps/RecoveryPointAdapter.hpp +501 -0
  489. amps-python-client-5.3.4.1/src/cpp/include/amps/RingBookmarkStore.hpp +669 -0
  490. amps-python-client-5.3.4.1/src/cpp/include/amps/SOWRecoveryPointAdapter.hpp +490 -0
  491. amps-python-client-5.3.4.1/src/cpp/include/amps/ServerChooser.hpp +145 -0
  492. amps-python-client-5.3.4.1/src/cpp/include/amps/ServerChooserImpl.hpp +95 -0
  493. amps-python-client-5.3.4.1/src/cpp/include/amps/amps.h +775 -0
  494. amps-python-client-5.3.4.1/src/cpp/include/amps/amps_generated.h +46 -0
  495. amps-python-client-5.3.4.1/src/cpp/include/amps/amps_impl.h +204 -0
  496. amps-python-client-5.3.4.1/src/cpp/include/amps/amps_ssl.h +78 -0
  497. amps-python-client-5.3.4.1/src/cpp/include/amps/ampscrc.hpp +210 -0
  498. amps-python-client-5.3.4.1/src/cpp/include/amps/ampsplusplus.hpp +8817 -0
  499. amps-python-client-5.3.4.1/src/cpp/include/amps/ampsuri.h +84 -0
  500. amps-python-client-5.3.4.1/src/cpp/include/amps/ampsver.h +41 -0
  501. amps-python-client-5.3.4.1/src/cpp/include/amps/ampsver.h.in +41 -0
  502. amps-python-client-5.3.4.1/src/cpp/include/amps/constants.hpp +194 -0
  503. amps-python-client-5.3.4.1/src/cpp/include/amps/util.hpp +1692 -0
  504. amps-python-client-5.3.4.1/src/cpp/src/amps_protocol.c +688 -0
  505. amps-python-client-5.3.4.1/src/cpp/src/amps_protocol_generated.h +80 -0
  506. amps-python-client-5.3.4.1/src/cpp/src/amps_ssl.c +489 -0
  507. amps-python-client-5.3.4.1/src/cpp/src/atfork.c +446 -0
  508. amps-python-client-5.3.4.1/src/cpp/src/client.c +483 -0
  509. amps-python-client-5.3.4.1/src/cpp/src/makefile +92 -0
  510. amps-python-client-5.3.4.1/src/cpp/src/message.c +837 -0
  511. amps-python-client-5.3.4.1/src/cpp/src/message_generated.h +611 -0
  512. amps-python-client-5.3.4.1/src/cpp/src/tcp.c +1489 -0
  513. amps-python-client-5.3.4.1/src/cpp/src/tcps.c +1894 -0
  514. amps-python-client-5.3.4.1/src/cpp/src/transports.c +123 -0
  515. amps-python-client-5.3.4.1/src/cpp/src/unix.c +984 -0
  516. amps-python-client-5.3.4.1/src/cpp/src/uri.c +301 -0
  517. amps-python-client-5.3.4.1/src/exponentialdelaystrategy.cpp +137 -0
  518. amps-python-client-5.3.4.1/src/failedwritehandler.cpp +116 -0
  519. amps-python-client-5.3.4.1/src/fixbuilder.cpp +146 -0
  520. amps-python-client-5.3.4.1/src/fixeddelaystrategy.cpp +114 -0
  521. amps-python-client-5.3.4.1/src/fixshredder.cpp +105 -0
  522. amps-python-client-5.3.4.1/src/fixshredder_docs.h +38 -0
  523. amps-python-client-5.3.4.1/src/haclient.cpp +691 -0
  524. amps-python-client-5.3.4.1/src/haclient_docs.h +132 -0
  525. amps-python-client-5.3.4.1/src/hybridpublishstore.cpp +137 -0
  526. amps-python-client-5.3.4.1/src/hybridpublishstore_docs.h +31 -0
  527. amps-python-client-5.3.4.1/src/memorybookmarkstore.cpp +373 -0
  528. amps-python-client-5.3.4.1/src/memorybookmarkstore_docs.h +39 -0
  529. amps-python-client-5.3.4.1/src/memorypublishstore.cpp +160 -0
  530. amps-python-client-5.3.4.1/src/memorypublishstore_docs.h +32 -0
  531. amps-python-client-5.3.4.1/src/message.cpp +765 -0
  532. amps-python-client-5.3.4.1/src/message_docs.h +306 -0
  533. amps-python-client-5.3.4.1/src/messagestream.cpp +623 -0
  534. amps-python-client-5.3.4.1/src/messagestream_docs.h +45 -0
  535. amps-python-client-5.3.4.1/src/mmapbookmarkstore.cpp +422 -0
  536. amps-python-client-5.3.4.1/src/nvfixbuilder.cpp +160 -0
  537. amps-python-client-5.3.4.1/src/nvfixbuilder_docs.h +33 -0
  538. amps-python-client-5.3.4.1/src/nvfixshredder.cpp +99 -0
  539. amps-python-client-5.3.4.1/src/nvfixshredder_docs.h +39 -0
  540. amps-python-client-5.3.4.1/src/publishstore.cpp +183 -0
  541. amps-python-client-5.3.4.1/src/raw_wrapper.cpp +756 -0
  542. amps-python-client-5.3.4.1/src/reason.cpp +71 -0
  543. amps-python-client-5.3.4.1/src/recoverypoint.cpp +135 -0
  544. amps-python-client-5.3.4.1/src/recoverypointadapter.cpp +171 -0
  545. amps-python-client-5.3.4.1/src/ringbookmarkstore.cpp +360 -0
  546. amps-python-client-5.3.4.1/src/serverchooser.cpp +245 -0
  547. amps-python-client-5.3.4.1/src/serverchooser_docs.h +39 -0
  548. amps-python-client-5.3.4.1/src/sowrecoverypointadapter.cpp +248 -0
  549. amps-python-client-5.3.4.1/src/store.cpp +62 -0
  550. amps-python-client-5.3.4.1/src/versioninfo.cpp +175 -0
amps-python-client-5.3.4.1/docs/command-reference/html/chapters/query-subscribe.html ADDED
@@ -0,0 +1,2123 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+
4
+
5
+ <html xmlns="http://www.w3.org/1999/xhtml">
6
+ <head>
7
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8
+
9
+ <title>4. Querying and Subscribing &#8212; Advanced Message Processing System (AMPS) Command Reference develop
10
+ documentation</title>
11
+
12
+ <link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
13
+ <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
14
+
15
+ <script type="text/javascript">
16
+ var DOCUMENTATION_OPTIONS = {
17
+ URL_ROOT: '../',
18
+ VERSION: 'develop',
19
+ COLLAPSE_INDEX: false,
20
+ FILE_SUFFIX: '.html',
21
+ HAS_SOURCE: true,
22
+ SOURCELINK_SUFFIX: '.txt'
23
+ };
24
+ </script>
25
+ <script type="text/javascript" src="../_static/jquery.js"></script>
26
+ <script type="text/javascript" src="../_static/underscore.js"></script>
27
+ <script type="text/javascript" src="../_static/doctools.js"></script>
28
+ <link rel="index" title="Index" href="../genindex.html" />
29
+ <link rel="search" title="Search" href="../search.html" />
30
+ <link rel="next" title="5. Removing or Acknowledging Messages" href="removing.html" />
31
+ <link rel="prev" title="3. Publishing to AMPS" href="publishing.html" />
32
+
33
+ <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
34
+
35
+
36
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
37
+
38
+ </head>
39
+ <body role="document">
40
+ <div class="document">
41
+
42
+ <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
43
+ <div class="sphinxsidebarwrapper">
44
+ <p class="logo"><a href="../index.html">
45
+ <img class="logo" src="../_static/flag_logo.png" alt="Logo"/>
46
+ </a></p>
47
+ <h3><a href="../index.html">Table Of Contents</a></h3>
48
+ <ul>
49
+ <li><a class="reference internal" href="#">4. Querying and Subscribing</a><ul>
50
+ <li><a class="reference internal" href="#delta-subscribe">delta_subscribe</a><ul>
51
+ <li><a class="reference internal" href="#header-fields">Header Fields</a></li>
52
+ <li><a class="reference internal" href="#options-field">Options Field</a></li>
53
+ <li><a class="reference internal" href="#returns">Returns</a></li>
54
+ <li><a class="reference internal" href="#errors">Errors</a></li>
55
+ </ul>
56
+ </li>
57
+ <li><a class="reference internal" href="#sow-and-delta-subscribe">sow_and_delta_subscribe</a><ul>
58
+ <li><a class="reference internal" href="#id1">Header Fields</a></li>
59
+ <li><a class="reference internal" href="#id2">Options Field</a></li>
60
+ <li><a class="reference internal" href="#id3">Returns</a><ul>
61
+ <li><a class="reference internal" href="#topicmatches">TopicMatches</a></li>
62
+ <li><a class="reference internal" href="#matches">Matches</a></li>
63
+ <li><a class="reference internal" href="#recordsreturned">RecordsReturned</a></li>
64
+ </ul>
65
+ </li>
66
+ <li><a class="reference internal" href="#id4">Errors</a></li>
67
+ </ul>
68
+ </li>
69
+ <li><a class="reference internal" href="#sow-and-subscribe">sow_and_subscribe</a><ul>
70
+ <li><a class="reference internal" href="#id5">Header Fields</a></li>
71
+ <li><a class="reference internal" href="#id6">Returns</a><ul>
72
+ <li><a class="reference internal" href="#id7">TopicMatches</a></li>
73
+ <li><a class="reference internal" href="#id8">Matches</a></li>
74
+ <li><a class="reference internal" href="#id9">RecordsReturned</a></li>
75
+ </ul>
76
+ </li>
77
+ <li><a class="reference internal" href="#id10">Options Field</a></li>
78
+ <li><a class="reference internal" href="#id11">Errors</a></li>
79
+ </ul>
80
+ </li>
81
+ <li><a class="reference internal" href="#subscribe">subscribe</a><ul>
82
+ <li><a class="reference internal" href="#id12">Header Fields</a></li>
83
+ <li><a class="reference internal" href="#id13">Options Field</a></li>
84
+ <li><a class="reference internal" href="#id14">Returns</a></li>
85
+ <li><a class="reference internal" href="#id15">Errors</a></li>
86
+ </ul>
87
+ </li>
88
+ <li><a class="reference internal" href="#sow">sow</a><ul>
89
+ <li><a class="reference internal" href="#id16">Header Fields</a></li>
90
+ <li><a class="reference internal" href="#id17">Options Field</a></li>
91
+ <li><a class="reference internal" href="#id18">Returns</a><ul>
92
+ <li><a class="reference internal" href="#id19">TopicMatches</a></li>
93
+ <li><a class="reference internal" href="#id20">Matches</a></li>
94
+ <li><a class="reference internal" href="#id21">RecordsReturned</a></li>
95
+ </ul>
96
+ </li>
97
+ <li><a class="reference internal" href="#id22">Errors</a></li>
98
+ </ul>
99
+ </li>
100
+ <li><a class="reference internal" href="#unsubscribe">unsubscribe</a><ul>
101
+ <li><a class="reference internal" href="#id23">Header Fields</a></li>
102
+ <li><a class="reference internal" href="#id24">Returns</a></li>
103
+ </ul>
104
+ </li>
105
+ </ul>
106
+ </li>
107
+ </ul>
108
+ <div class="relations">
109
+ <h3>Related Topics</h3>
110
+ <ul>
111
+ <li><a href="../index.html">Documentation overview</a><ul>
112
+ <li>Previous: <a href="publishing.html" title="previous chapter">3. Publishing to AMPS</a></li>
113
+ <li>Next: <a href="removing.html" title="next chapter">5. Removing or Acknowledging Messages</a></li>
114
+ </ul></li>
115
+ </ul>
116
+ </div>
117
+ <div id="searchbox" style="display: none" role="search">
118
+ <h3>Quick search</h3>
119
+ <form class="search" action="../search.html" method="get">
120
+ <div><input type="text" name="q" /></div>
121
+ <div><input type="submit" value="Go" /></div>
122
+ <input type="hidden" name="check_keywords" value="yes" />
123
+ <input type="hidden" name="area" value="default" />
124
+ </form>
125
+ </div>
126
+ <script type="text/javascript">$('#searchbox').show(0);</script>
127
+ </div>
128
+ </div>
129
+ <div class="documentwrapper">
130
+ <div class="bodywrapper">
131
+ <div class="body" role="main">
132
+
133
+ <div class="section" id="querying-and-subscribing">
134
+ <span id="command-guide-query-subscribe"></span><h1>4. Querying and Subscribing<a class="headerlink" href="#querying-and-subscribing" title="Permalink to this headline">¶</a></h1>
135
+ <p>This section describes commands used to
136
+ retrieve content messages from AMPS,
137
+ including both queries and subscriptions.</p>
138
+ <p>For details on the differences between these
139
+ commands, see the <em>AMPS User Guide</em>.</p>
140
+ <div class="section" id="delta-subscribe">
141
+ <h2>delta_subscribe<a class="headerlink" href="#delta-subscribe" title="Permalink to this headline">¶</a></h2>
142
+ <p>The <code class="docutils literal"><span class="pre">delta_subscribe</span></code> command is like the <code class="docutils literal"><span class="pre">subscribe</span></code> command except
143
+ that subscriptions placed through <code class="docutils literal"><span class="pre">delta_subscribe</span></code> will receive only
144
+ messages that have changed between the SOW record and the new update.</p>
145
+ <p>If <code class="docutils literal"><span class="pre">delta_subscribe</span></code> is used on a topic which does not have a SOW
146
+ store defined, then <code class="docutils literal"><span class="pre">delta_subscribe</span></code> behaves like a <code class="docutils literal"><span class="pre">subscribe</span></code>
147
+ command.</p>
148
+ <div class="section" id="header-fields">
149
+ <h3>Header Fields<a class="headerlink" href="#header-fields" title="Permalink to this headline">¶</a></h3>
150
+ <p>The following table
151
+ contains the header fields available to a <code class="docutils literal"><span class="pre">delta_subscribe</span></code> command.</p>
152
+ <table border="1" class="docutils" id="command-delta-sub-header-field">
153
+ <colgroup>
154
+ <col width="50%" />
155
+ <col width="50%" />
156
+ </colgroup>
157
+ <thead valign="bottom">
158
+ <tr class="row-odd"><th class="head"><strong>Field</strong></th>
159
+ <th class="head"><strong>Description</strong></th>
160
+ </tr>
161
+ </thead>
162
+ <tbody valign="top">
163
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">Command</span></code></td>
164
+ <td>Command to be executed. Value: <code class="docutils literal"><span class="pre">delta_publish</span></code></td>
165
+ </tr>
166
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">Topic</span></code></td>
167
+ <td>Topic with which to place a subscription.</td>
168
+ </tr>
169
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">AckType</span></code></td>
170
+ <td>Acknowledgment type for the <code class="docutils literal"><span class="pre">delta_subscribe</span></code>
171
+ command. Value is a comma separated list of one
172
+ or more of the following: <code class="docutils literal"><span class="pre">none</span></code>,
173
+ <code class="docutils literal"><span class="pre">received</span></code>, <code class="docutils literal"><span class="pre">processed</span></code>, <code class="docutils literal"><span class="pre">completed</span></code> or
174
+ <code class="docutils literal"><span class="pre">stats</span></code>.</td>
175
+ </tr>
176
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">CommandId</span></code></td>
177
+ <td>If specified with an AMPS command requesting an
178
+ acknowledgment message, all requested
179
+ acknowledgment messages will contain the
180
+ <code class="docutils literal"><span class="pre">CommandId</span></code> in the acknowledgment response
181
+ header.</td>
182
+ </tr>
183
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">DataOnly</span></code></td>
184
+ <td>A Boolean (<code class="docutils literal"><span class="pre">true</span></code> or <code class="docutils literal"><span class="pre">false</span></code>) used to
185
+ determine the type of data sent to the
186
+ subscriber. A value of <code class="docutils literal"><span class="pre">true</span></code> will, for
187
+ example, not include a SOAP envelope.</td>
188
+ </tr>
189
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">Filter</span></code></td>
190
+ <td>String which is used as a content filter
191
+ expression. When using XML, the filter must be
192
+ wrapped in a <code class="docutils literal"><span class="pre">CDATA</span></code>.</td>
193
+ </tr>
194
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">Options</span></code></td>
195
+ <td>A comma separated list of flags available to the
196
+ <code class="docutils literal"><span class="pre">subscribe</span></code> command.
197
+ <a class="reference internal" href="#command-delta-subscribe-options"><span class="std std-ref">Table 3.2</span></a>
198
+ describes the <code class="docutils literal"><span class="pre">Options</span></code> available for use in
199
+ the <code class="docutils literal"><span class="pre">delta-subscribe</span></code> command.</td>
200
+ </tr>
201
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">SendEmpty</span></code></td>
202
+ <td>Boolean (<code class="docutils literal"><span class="pre">true</span></code> or <code class="docutils literal"><span class="pre">false</span></code>) value used to
203
+ determine whether empty messages which are
204
+ published will be forwarded to matching
205
+ subscriptions. The default value is <code class="docutils literal"><span class="pre">true</span></code>.</td>
206
+ </tr>
207
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">SendSubscriptionIds</span></code></td>
208
+ <td>Boolean (<code class="docutils literal"><span class="pre">true</span></code> or <code class="docutils literal"><span class="pre">false</span></code>) subscription
209
+ identifiers will not be sent for all matched
210
+ messages if set to <code class="docutils literal"><span class="pre">false</span></code>.</td>
211
+ </tr>
212
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">SubscriptionId</span></code></td>
213
+ <td><p class="first">The subscription ID for this command. When
214
+ provided with a new subscription, this is the
215
+ identifier that AMPS will use for the
216
+ subscription. When provided with the <code class="docutils literal"><span class="pre">replace</span></code>
217
+ option, this field specifies the subscription to
218
+ replace. When provided with a <code class="docutils literal"><span class="pre">pause</span></code> or
219
+ <code class="docutils literal"><span class="pre">resume</span></code> option, this field specifies the
220
+ subscriptions to pause or resume.</p>
221
+ <p class="last">For a new subscription, the AMPS clients will
222
+ generate a subscription ID if one is not
223
+ provided.</p>
224
+ </td>
225
+ </tr>
226
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">Bookmark</span></code></td>
227
+ <td>A bookmark specifying the point in the
228
+ transaction log at which to start the
229
+ subscription. If the topic provided is not
230
+ recorded in a transaction log, AMPS enters the
231
+ subscription without replaying messages. You can
232
+ provide a single bookmark, or a comma-delimited
233
+ list of bookmarks. When a list is provided, AMPS
234
+ starts the subscription at the earliest bookmark
235
+ in the list.</td>
236
+ </tr>
237
+ </tbody>
238
+ </table>
239
+ <p><em>Header fields supported by delta_subscribe</em></p>
240
+ </div>
241
+ <div class="section" id="options-field">
242
+ <h3>Options Field<a class="headerlink" href="#options-field" title="Permalink to this headline">¶</a></h3>
243
+ <p>The following table
244
+ contains a list of the <code class="docutils literal"><span class="pre">Options</span></code> available and
245
+ their definitions when used in the AMPS <code class="docutils literal"><span class="pre">sow_and_delta_subscribe</span></code>
246
+ command.</p>
247
+ <table border="1" class="docutils" id="command-delta-subscribe-options">
248
+ <colgroup>
249
+ <col width="50%" />
250
+ <col width="50%" />
251
+ </colgroup>
252
+ <thead valign="bottom">
253
+ <tr class="row-odd"><th class="head"><strong>Option</strong></th>
254
+ <th class="head"><strong>Description</strong></th>
255
+ </tr>
256
+ </thead>
257
+ <tbody valign="top">
258
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">none</span></code></td>
259
+ <td>This is the default <code class="docutils literal"><span class="pre">Options</span></code> type.</td>
260
+ </tr>
261
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">bookmark</span></code></td>
262
+ <td><p class="first">Specifies that the subscription should return
263
+ bookmarks, if available, on each publish
264
+ message. Bookmarks are only available if the
265
+ topic that is subscribed to is recorded in the
266
+ transaction log.</p>
267
+ <p>Notice that this option does not set the
268
+ starting point for a bookmark subscription: use
269
+ the <code class="docutils literal"><span class="pre">Bookmark</span></code> header for that purpose.</p>
270
+ <p class="last">This option is not required to receive bookmarks
271
+ for a bookmark subscription. Those subscriptions
272
+ always include bookmarks on each publish message.</p>
273
+ </td>
274
+ </tr>
275
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">conflation=n</span></code></td>
276
+ <td><p class="first">Specifies whether to conflate this
277
+ subscription.The value provided can be a time
278
+ interval, <code class="docutils literal"><span class="pre">auto</span></code>, or <code class="docutils literal"><span class="pre">none</span></code></p>
279
+ <p>When present and set to a value other than none,
280
+ enables conflation for the subscription.</p>
281
+ <p>Can also be set to <code class="docutils literal"><span class="pre">auto</span></code>, which requests that
282
+ AMPS attempt to determine an appropriate
283
+ conflation interval based on client consumption.</p>
284
+ <p>Recognizes the same time specifiers used in the
285
+ AMPS configuration file (for example, <code class="docutils literal"><span class="pre">100ms</span></code>
286
+ or <code class="docutils literal"><span class="pre">1s</span></code> or <code class="docutils literal"><span class="pre">1m</span></code>).</p>
287
+ <p class="last">Defaults to <code class="docutils literal"><span class="pre">none</span></code>.</p>
288
+ </td>
289
+ </tr>
290
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">conflation_key=[key]</span></code></td>
291
+ <td><p class="first">When conflation is enabled, specifies the fields
292
+ to use to determine message uniqueness. The
293
+ format of this option is a comma-delimited list
294
+ of XPath identifiers within brackets. For
295
+ example, to conflate based on the value of the
296
+ <code class="docutils literal"><span class="pre">/tickerId</span></code> and <code class="docutils literal"><span class="pre">/customerId</span></code> within a
297
+ message the value of this option would be
298
+ <code class="docutils literal"><span class="pre">[/tickerId,/customerId]</span></code>.</p>
299
+ <p>Defaults to the SOW key fields for SOW topics.
300
+ No default for non-SOW topics. This option is
301
+ required for non-SOW topics.</p>
302
+ <p class="last">This option is not valid with the <code class="docutils literal"><span class="pre">oof</span></code> option
303
+ unless the keys provided are identical to the
304
+ keys for the topic.</p>
305
+ </td>
306
+ </tr>
307
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">live</span></code></td>
308
+ <td>Tells AMPS to send messages to subscribing
309
+ clients before they have been persisted to the
310
+ transaction log. This option is only valid for
311
+ bookmark subscriptions.</td>
312
+ </tr>
313
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">max_backlog=n</span></code></td>
314
+ <td>When subscribing to a queue, the number of
315
+ unacknowledged messages the client is willing to
316
+ accept at a time. AMPS will not exceed this
317
+ number, but may choose a smaller number
318
+ depending on the queue configuration.</td>
319
+ </tr>
320
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">no_empties</span></code></td>
321
+ <td>Tells AMPS not to send empty publish messages to
322
+ matching subscriptions. This can be useful for
323
+ suppressing messages where no fields have
324
+ changed.</td>
325
+ </tr>
326
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">no_sowkey</span></code></td>
327
+ <td>Tells AMPS not to send the AMPS-generated SowKey
328
+ for messages.</td>
329
+ </tr>
330
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">non_regex_topic</span></code></td>
331
+ <td>Specifies that the topic name should be a literal
332
+ match, even if the topic name contains regular
333
+ expression characters.</td>
334
+ </tr>
335
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">oof</span></code></td>
336
+ <td>Send an OOF message for records which have
337
+ fallen out of focus from the original
338
+ subscription. When focus tracking is enabled,
339
+ AMPS will also deliver the full message to a
340
+ subscription when a previously out-of-focus
341
+ message comes into focus.</td>
342
+ </tr>
343
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">pause</span></code></td>
344
+ <td>Pause a bookmark subscription. This option is
345
+ only valid for bookmark subscriptions that do
346
+ not use the <code class="docutils literal"><span class="pre">live</span></code> option. When this option is
347
+ present, AMPS pauses the subscription or
348
+ subscriptions provided in the <code class="docutils literal"><span class="pre">SubId</span></code> of the
349
+ command.</td>
350
+ </tr>
351
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">rate=n</span></code></td>
352
+ <td>Set the maximum message delivery rate for a
353
+ bookmark subscription. This option is only valid
354
+ for bookmark subscriptions that do not use the
355
+ <code class="docutils literal"><span class="pre">live</span></code> option. The rate can be specified as
356
+ either the number of messages per second (for
357
+ example, <code class="docutils literal"><span class="pre">1000</span></code>), the number of bytes per
358
+ second (for example, <code class="docutils literal"><span class="pre">100KB</span></code>), or a multiple
359
+ of the original replay rate (for example,
360
+ <code class="docutils literal"><span class="pre">1.5X</span></code>).</td>
361
+ </tr>
362
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">replace</span></code></td>
363
+ <td>Replace the subscription associated with
364
+ <code class="docutils literal"><span class="pre">CmdId</span></code> with another subscription. When
365
+ provided as part of <code class="docutils literal"><span class="pre">sow_and_subscribe</span></code>, AMPS
366
+ runs a SOW query for the new subscription.</td>
367
+ </tr>
368
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">resume</span></code></td>
369
+ <td>Resume a bookmark subscription. This option is
370
+ only valid for bookmark subscriptions that do
371
+ not use the <code class="docutils literal"><span class="pre">live</span></code> option. When this option is
372
+ present, AMPS resumes the subscription or
373
+ subscriptions provided in the <code class="docutils literal"><span class="pre">SubId</span></code> of the
374
+ command.</td>
375
+ </tr>
376
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">send_keys</span></code></td>
377
+ <td>AMPS will send the SOW keys fields back with
378
+ messages from the SOW. Notice that
379
+ without this option, messages will never contain
380
+ these fields (since, by definition, they do not
381
+ change from update to update).</td>
382
+ </tr>
383
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">timestamp</span></code></td>
384
+ <td>AMPS will include a header with the time at
385
+ which this instance of AMPS processed the
386
+ incoming publish command for this message.</td>
387
+ </tr>
388
+ </tbody>
389
+ </table>
390
+ <p><em>Options types supported by delta_subscribe</em></p>
391
+ </div>
392
+ <div class="section" id="returns">
393
+ <h3>Returns<a class="headerlink" href="#returns" title="Permalink to this headline">¶</a></h3>
394
+ <p>A <code class="docutils literal"><span class="pre">delta_subscribe</span></code> command returns the following command types:</p>
395
+ <table border="1" class="docutils">
396
+ <colgroup>
397
+ <col width="50%" />
398
+ <col width="50%" />
399
+ </colgroup>
400
+ <thead valign="bottom">
401
+ <tr class="row-odd"><th class="head"><strong>Command</strong></th>
402
+ <th class="head"><em>Description</em></th>
403
+ </tr>
404
+ </thead>
405
+ <tbody valign="top">
406
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">publish</span></code></td>
407
+ <td>A message published to AMPS.</td>
408
+ </tr>
409
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">oof</span></code></td>
410
+ <td>Returned when the <code class="docutils literal"><span class="pre">oof</span></code> option is requested
411
+ on the command, the subscription is to a topic
412
+ in the State of the World, and the subscription
413
+ is not a bookmark subscribe.</td>
414
+ </tr>
415
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">ack</span></code></td>
416
+ <td>Acknowledgements requested, as described
417
+ in the following section.</td>
418
+ </tr>
419
+ </tbody>
420
+ </table>
421
+ <p><em>Command types returned by delta_subscribe</em></p>
422
+ <p>For a <code class="docutils literal"><span class="pre">delta_subscribe</span></code> message, AMPS will send acknowledgment
423
+ messages for the following <code class="docutils literal"><span class="pre">AckType</span></code> fields: <code class="docutils literal"><span class="pre">received</span></code>,
424
+ <code class="docutils literal"><span class="pre">processed</span></code>, <code class="docutils literal"><span class="pre">persisted</span></code> and <code class="docutils literal"><span class="pre">stats</span></code> along with a populated
425
+ <code class="docutils literal"><span class="pre">Status</span></code> header field describing the acknowledgment.</p>
426
+ <p>The following table contains the <code class="docutils literal"><span class="pre">AckType</span></code> messages which can be
427
+ returned by a <code class="docutils literal"><span class="pre">delta_subscribe</span></code>.</p>
428
+ <table border="1" class="docutils" id="command-delta-sub-acks">
429
+ <colgroup>
430
+ <col width="50%" />
431
+ <col width="50%" />
432
+ </colgroup>
433
+ <thead valign="bottom">
434
+ <tr class="row-odd"><th class="head"><strong>Acknowledgment</strong></th>
435
+ <th class="head"><strong>Description</strong></th>
436
+ </tr>
437
+ </thead>
438
+ <tbody valign="top">
439
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">none</span></code></td>
440
+ <td>No <code class="docutils literal"><span class="pre">ack</span></code> is returned. This is the default
441
+ behavior.</td>
442
+ </tr>
443
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">completed</span></code></td>
444
+ <td>When a bookmark is present on the subscribe
445
+ request and this acknowledgment is requested,
446
+ AMPS sends a <code class="docutils literal"><span class="pre">completed</span></code> acknowledgment
447
+ message to indicate that bookmark replay is
448
+ complete. Further messages on this subscription
449
+ are from new publishes.</td>
450
+ </tr>
451
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">persisted</span></code></td>
452
+ <td>When a bookmark is present and this
453
+ acknowledgment is requested, AMPS periodically
454
+ sends a <code class="docutils literal"><span class="pre">persisted</span></code> acknowledgment message to
455
+ indicate the most recent bookmark in the
456
+ server&#8217;s transaction log.</td>
457
+ </tr>
458
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">processed</span></code></td>
459
+ <td>AMPS has compiled the filters for the
460
+ <code class="docutils literal"><span class="pre">delta_subscribe</span></code> message(s).</td>
461
+ </tr>
462
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">received</span></code></td>
463
+ <td>The <code class="docutils literal"><span class="pre">delta_subscribe</span></code> message has been
464
+ received.</td>
465
+ </tr>
466
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">stats</span></code></td>
467
+ <td>Returns an acknowledgment message with
468
+ <code class="docutils literal"><span class="pre">Matches</span></code>, <code class="docutils literal"><span class="pre">TopicMatches</span></code> and
469
+ <code class="docutils literal"><span class="pre">RecordsReturned</span></code>.</td>
470
+ </tr>
471
+ </tbody>
472
+ </table>
473
+ <p><em>Acknowledgment messages supported by delta_publish</em></p>
474
+ </div>
475
+ <div class="section" id="errors">
476
+ <h3>Errors<a class="headerlink" href="#errors" title="Permalink to this headline">¶</a></h3>
477
+ <p>Any errors that occur during this command will be returned in the status
478
+ of a <code class="docutils literal"><span class="pre">processed</span></code> acknowledgment and logged to the log file. Regardless
479
+ of success or failure, the <code class="docutils literal"><span class="pre">processed</span></code> acknowledgment will be returned
480
+ only if requested by including processed in the <code class="docutils literal"><span class="pre">AckType</span></code> field of the
481
+ <code class="docutils literal"><span class="pre">delta_subscribe</span></code> message header.</p>
482
+ </div>
483
+ </div>
484
+ <div class="section" id="sow-and-delta-subscribe">
485
+ <h2>sow_and_delta_subscribe<a class="headerlink" href="#sow-and-delta-subscribe" title="Permalink to this headline">¶</a></h2>
486
+ <p>A <code class="docutils literal"><span class="pre">sow_and_delta_subscribe</span></code> command is used to combine the
487
+ functionality of commands <code class="docutils literal"><span class="pre">sow</span></code> and a <code class="docutils literal"><span class="pre">delta_subscribe</span></code> in a single
488
+ command.</p>
489
+ <p>The <code class="docutils literal"><span class="pre">sow_and_delta_subscribe</span></code> command is used (a) to query the
490
+ contents of a SOW topic (this is the <code class="docutils literal"><span class="pre">sow</span></code> command); and (b) to place
491
+ a subscription such that any messages matching the subscribed SOW topic
492
+ and query filter will be published to the AMPS client (this is the
493
+ <code class="docutils literal"><span class="pre">delta_subscribe</span></code> command). As with the <code class="docutils literal"><span class="pre">delta_subscribe</span></code> command,
494
+ <code class="docutils literal"><span class="pre">publish</span></code> messages representing updates to SOW records will contain
495
+ only the information that has changed.</p>
496
+ <p>If a <code class="docutils literal"><span class="pre">sow_and_delta_subscribe</span></code> is issued on a record that does not
497
+ currently exist in the SOW topic, or if it is used on a topic that does
498
+ not have a SOW-topic store defined, then a <code class="docutils literal"><span class="pre">sow_and_delta_subscribe</span></code>
499
+ will behave like a <code class="docutils literal"><span class="pre">sow_and_subscribe</span></code> command.</p>
500
+ <div class="section" id="id1">
501
+ <h3>Header Fields<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h3>
502
+ <p>The following table
503
+ contains the header fields supported by a <code class="docutils literal"><span class="pre">sow_and_delta_subscribe</span></code> command.</p>
504
+ <table border="1" class="docutils" id="command-sow-and-delta-subscribe-headers">
505
+ <colgroup>
506
+ <col width="50%" />
507
+ <col width="50%" />
508
+ </colgroup>
509
+ <thead valign="bottom">
510
+ <tr class="row-odd"><th class="head"><strong>Field</strong></th>
511
+ <th class="head"><strong>Description</strong></th>
512
+ </tr>
513
+ </thead>
514
+ <tbody valign="top">
515
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">Command</span></code></td>
516
+ <td>The command to be executed. Value:
517
+ <code class="docutils literal"><span class="pre">sow_and_delta_subscribe</span></code></td>
518
+ </tr>
519
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">Topic</span></code></td>
520
+ <td>The target SOW topic to query and subscribe to.</td>
521
+ </tr>
522
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">AckType</span></code></td>
523
+ <td>Acknowledgment type for the given command. Value
524
+ is a comma separated string of one of more of
525
+ the following: <code class="docutils literal"><span class="pre">none</span></code>, <code class="docutils literal"><span class="pre">received</span></code>,
526
+ <code class="docutils literal"><span class="pre">processed</span></code>, <code class="docutils literal"><span class="pre">completed</span></code> or <code class="docutils literal"><span class="pre">stats</span></code>.</td>
527
+ </tr>
528
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">BatchSize</span></code></td>
529
+ <td>Number of records to return in a single sow
530
+ query results message. While the default value
531
+ is 1, it is recommended to use a higher value,
532
+ as even small increases can yield greater
533
+ performance in query result delivery.</td>
534
+ </tr>
535
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">Bookmark</span></code></td>
536
+ <td><p class="first">A bookmark specifying the historical state of
537
+ the SOW to return results from. For SOW topics
538
+ where historical query is enabled, AMPS returns
539
+ the saved state of the SOW as of that bookmark.
540
+ For SOW topics where historical query is not
541
+ enabled, AMPS ignores this parameter.</p>
542
+ <p class="last">If the topic is enabled for historical query and
543
+ AMPS has a transaction log that covers the
544
+ topic, AMPS returns the saved state of the SOW
545
+ as of that bookmark and starts a bookmark
546
+ subscription at a point in the transaction log
547
+ immediately after the point at which the SOW
548
+ state was saved. In other words, if the
549
+ granularity of the historical SOW preserves the
550
+ state of the SOW at 11:30:10 AM and 11:30:50 AM,
551
+ a request for a bookmark at 11:30:20 AM will
552
+ provide the SOW state as of 11:30:10 AM, and
553
+ begin the replay immediately after that SOW
554
+ state. This ensures no messages are missed, but
555
+ means that the subscription may begin before the
556
+ bookmark.</p>
557
+ </td>
558
+ </tr>
559
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">CommandId</span></code></td>
560
+ <td>If specified with an AMPS command requesting an
561
+ acknowledgment message, all <code class="docutils literal"><span class="pre">ack</span></code> messages
562
+ will contain the <code class="docutils literal"><span class="pre">CommandId</span></code> in the
563
+ acknowledgment message.</td>
564
+ </tr>
565
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">DataOnly</span></code></td>
566
+ <td>If <code class="docutils literal"><span class="pre">true</span></code>, send only raw data to subscriber
567
+ for a matching publish message. For example:
568
+ this will remove the SOAP envelope in an XML
569
+ message.</td>
570
+ </tr>
571
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">Filter</span></code></td>
572
+ <td>Content filter expression.</td>
573
+ </tr>
574
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">Options</span></code></td>
575
+ <td>A comma separated list of one or more of the
576
+ options in
577
+ <a class="reference internal" href="#command-sow-and-delta-subscribe-options"><span class="std std-ref">Table 3.5</span></a>
578
+ , which describes all of the
579
+ <code class="docutils literal"><span class="pre">Options</span></code> available.</td>
580
+ </tr>
581
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">OrderBy</span></code></td>
582
+ <td>Return the SOW results sorted by the specified
583
+ fields. Fields are a comma-delimited list of
584
+ AMPS identifiers, and may optionally include a
585
+ sort specifier, <code class="docutils literal"><span class="pre">ASC</span></code> or <code class="docutils literal"><span class="pre">DESC</span></code>.</td>
586
+ </tr>
587
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">QueryId</span></code></td>
588
+ <td>Identifier used to identify the client&#8217;s SOW
589
+ topic query. This identifier will be added to
590
+ all messages that represent a response to the
591
+ <code class="docutils literal"><span class="pre">sow_and_delta_subscribe</span></code> command.</td>
592
+ </tr>
593
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">SendEmpty</span></code></td>
594
+ <td>If set to <code class="docutils literal"><span class="pre">true</span></code>, empty published messages are
595
+ forwarded to matching subscriptions. Default is
596
+ <code class="docutils literal"><span class="pre">true</span></code>.</td>
597
+ </tr>
598
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">SendOOF</span></code></td>
599
+ <td>Messages that have fallen out of focus from the
600
+ subscription are sent to the client. Default is
601
+ <code class="docutils literal"><span class="pre">false</span></code>.</td>
602
+ </tr>
603
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">SendKeys</span></code></td>
604
+ <td>Option to instruct AMPS that the client would
605
+ like to receive the <code class="docutils literal"><span class="pre">SowKey</span></code> back.</td>
606
+ </tr>
607
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">SendSubscriptionIds</span></code></td>
608
+ <td>If <code class="docutils literal"><span class="pre">true</span></code> subscription identifiers will be
609
+ sent for a matched message.</td>
610
+ </tr>
611
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">SowKeys</span></code></td>
612
+ <td>A comma-delimited list of <code class="docutils literal"><span class="pre">SowKeys</span></code> that
613
+ identify the messages to return from the query.
614
+ For example, you might send a query with the
615
+ SowKeys value <code class="docutils literal"><span class="pre">42,100,3467</span></code> which would return
616
+ records with those SowKey values, if any exist
617
+ in the SOW.</td>
618
+ </tr>
619
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">SubscriptionId</span></code></td>
620
+ <td><p class="first">The subscription ID for this command. When
621
+ provided with a new subscription, this is the
622
+ identifier that AMPS will use for the
623
+ subscription. When provided with the <code class="docutils literal"><span class="pre">replace</span></code>
624
+ option, this field specifies the subscription to
625
+ replace. When provided with a <code class="docutils literal"><span class="pre">pause</span></code> or
626
+ <code class="docutils literal"><span class="pre">resume</span></code> option, this field specifies the
627
+ subscriptions to pause or resume.</p>
628
+ <p class="last">For a new subscription, the AMPS clients will
629
+ generate a subscription ID if one is not
630
+ provided.</p>
631
+ </td>
632
+ </tr>
633
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">TopN</span></code></td>
634
+ <td>Return up to the number of messages specified
635
+ from the SOW query.</td>
636
+ </tr>
637
+ </tbody>
638
+ </table>
639
+ <p><em>Header fields supported by sow_and_delta_subscribe</em></p>
640
+ </div>
641
+ <div class="section" id="id2">
642
+ <h3>Options Field<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h3>
643
+ <p>The following table contains a list of the <code class="docutils literal"><span class="pre">Options</span></code> available and
644
+ their definitions when used in the AMPS <code class="docutils literal"><span class="pre">sow_and_delta_subscribe</span></code>
645
+ command.</p>
646
+ <table border="1" class="docutils" id="command-sow-and-delta-subscribe-options">
647
+ <colgroup>
648
+ <col width="50%" />
649
+ <col width="50%" />
650
+ </colgroup>
651
+ <thead valign="bottom">
652
+ <tr class="row-odd"><th class="head"><strong>Option</strong></th>
653
+ <th class="head"><strong>Description</strong></th>
654
+ </tr>
655
+ </thead>
656
+ <tbody valign="top">
657
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">none</span></code></td>
658
+ <td>This is the default <code class="docutils literal"><span class="pre">Options</span></code> type.</td>
659
+ </tr>
660
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">bookmark</span></code></td>
661
+ <td><p class="first">Specifies that the subscription should return
662
+ bookmarks, if available, on each publish
663
+ message. Bookmarks are only available if the
664
+ topic that is subscribed to is recorded in the
665
+ transaction log.</p>
666
+ <p>Notice that this option does not set the
667
+ starting point for a bookmark subscription: use
668
+ the <code class="docutils literal"><span class="pre">Bookmark</span></code> header for that purpose.</p>
669
+ <p class="last">This option is not required to receive bookmarks
670
+ for a bookmark subscription. Those subscriptions
671
+ always include bookmarks on each publish message.</p>
672
+ </td>
673
+ </tr>
674
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">conflation=n</span></code></td>
675
+ <td><p class="first">Specifies whether to conflate this
676
+ subscription.The value provided can be a time
677
+ interval, <code class="docutils literal"><span class="pre">auto</span></code>, or <code class="docutils literal"><span class="pre">none</span></code></p>
678
+ <p>When present and set to a value other than none,
679
+ enables conflation for the subscription.</p>
680
+ <p>Can also be set to <code class="docutils literal"><span class="pre">auto</span></code>, which requests that
681
+ AMPS attempt to determine an appropriate
682
+ conflation interval based on client consumption.</p>
683
+ <p>Recognizes the same time specifiers used in the
684
+ AMPS configuration file (for example, <code class="docutils literal"><span class="pre">100ms</span></code>
685
+ or <code class="docutils literal"><span class="pre">1s</span></code> or <code class="docutils literal"><span class="pre">1m</span></code>).</p>
686
+ <p class="last">Defaults to <code class="docutils literal"><span class="pre">none</span></code>.</p>
687
+ </td>
688
+ </tr>
689
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">conflation_key=[key]</span></code></td>
690
+ <td><p class="first">When conflation is enabled, specifies the fields
691
+ to use to determine message uniqueness. The
692
+ format of this option is a comma-delimited list
693
+ of XPath identifiers within brackets. For
694
+ example, to conflate based on the value of the
695
+ <code class="docutils literal"><span class="pre">/tickerId</span></code> and <code class="docutils literal"><span class="pre">/customerId</span></code> within a
696
+ message the value of this option would be
697
+ <code class="docutils literal"><span class="pre">[/tickerId,/customerId]</span></code>.</p>
698
+ <p>Defaults to the SOW key fields for SOW topics.
699
+ No default for non-SOW topics. This option is
700
+ required for non-SOW topics.</p>
701
+ <p class="last">This option is not valid with the <code class="docutils literal"><span class="pre">oof</span></code> option
702
+ unless the keys provided are identical to the
703
+ keys for the topic.</p>
704
+ </td>
705
+ </tr>
706
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">grouping=[keys]</span></code></td>
707
+ <td><p class="first">For use with aggregated subscriptions.</p>
708
+ <p>The format of this option is a comma-delimited
709
+ list of XPath identifiers within brackets. For
710
+ example, to aggregate entries based on their
711
+ <code class="docutils literal"><span class="pre">/description</span></code> (producing one record in the
712
+ aggregation for each distinct value in
713
+ <code class="docutils literal"><span class="pre">/description</span></code>), you would use the following
714
+ option:</p>
715
+ <p>This option must contain an entry for every
716
+ field in the aggregated message. If there is no
717
+ entry for a field in this option, that field
718
+ will not appear in the aggregated message, even
719
+ if the field is in the underlying message.</p>
720
+ <p class="last">When this option is provided, a <code class="docutils literal"><span class="pre">projection</span></code>
721
+ must also be provided. This option cannot be
722
+ used with a bookmark.</p>
723
+ </td>
724
+ </tr>
725
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">live</span></code></td>
726
+ <td>Tells AMPS to send messages to subscribing
727
+ clients before they have been persisted to the
728
+ transaction log.</td>
729
+ </tr>
730
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">no_empties</span></code></td>
731
+ <td>Tells AMPS not to send empty publish messages to
732
+ matching subscriptions. This can be useful for
733
+ suppressing messages where no fields have
734
+ changed.</td>
735
+ </tr>
736
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">no_sowkey</span></code></td>
737
+ <td>Tells AMPS not to send the AMPS-generated
738
+ <code class="docutils literal"><span class="pre">SowKey</span></code> for messages.</td>
739
+ </tr>
740
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">non_regex_topic</span></code></td>
741
+ <td>Specifies that the topic name should be a literal
742
+ match, even if the topic name contains
743
+ regular expression characters.</td>
744
+ </tr>
745
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">oof</span></code></td>
746
+ <td>Send an <code class="docutils literal"><span class="pre">OOF</span></code> message for records that have
747
+ fallen out of focus from the original
748
+ subscription. When focus tracking is enabled,
749
+ AMPS will also deliver the full message to a
750
+ subscription when a previously out-of-focus
751
+ message comes into focus.</td>
752
+ </tr>
753
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">projection=[fields]</span></code></td>
754
+ <td><p class="first">For use with aggregated subscriptions.</p>
755
+ <p>Specifies a comma-delimited set of fields to
756
+ project, within brackets. Each entry has the
757
+ format described in the AMPS User Guide.</p>
758
+ <p>This option must contain an entry for every
759
+ field in the aggregated message. If there is no
760
+ entry for a field in this option, that field
761
+ will not appear in the aggregated message, even
762
+ if the field is in the underlying message.</p>
763
+ <p>There is no default for this option. When this
764
+ option is provided, a <code class="docutils literal"><span class="pre">grouping</span></code> must also be
765
+ provided. This option cannot be used with a
766
+ bookmark.</p>
767
+ <p class="last">The maximum size of this option is 64KB.</p>
768
+ </td>
769
+ </tr>
770
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">replace</span></code></td>
771
+ <td>Replace the subscription associated with
772
+ <code class="docutils literal"><span class="pre">CmdId</span></code> with another subscription.</td>
773
+ </tr>
774
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">top_n=n</span></code></td>
775
+ <td>AMPS will provide at most <code class="docutils literal"><span class="pre">n</span></code> records, starting
776
+ at the beginning of the result set as defined by
777
+ the <code class="docutils literal"><span class="pre">OrderBy</span></code> header. This option is equivalent
778
+ to providing a <code class="docutils literal"><span class="pre">TopN</span></code> header.</td>
779
+ </tr>
780
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">skip_n=n</span></code></td>
781
+ <td>AMPS will skip the specified number of records
782
+ in the result set before returning results.
783
+ This option is used with the <code class="docutils literal"><span class="pre">top_n</span></code> option
784
+ to create a paginated subscription.</td>
785
+ </tr>
786
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">send_keys</span></code></td>
787
+ <td>AMPS will send the SOW keys (that is, the data
788
+ fields used to identify unique messages in the
789
+ SOW) back with matching messages from the SOW.</td>
790
+ </tr>
791
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">select</span></code></td>
792
+ <td>Specifies the fields to include in messages
793
+ provided on this subscription. The contents
794
+ of this option are a comma-delimited list of
795
+ inclusion specifiers.</td>
796
+ </tr>
797
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">timestamp</span></code></td>
798
+ <td>AMPS will include a header with the time at
799
+ which this instance of AMPS processed the
800
+ incoming publish command for this message.</td>
801
+ </tr>
802
+ </tbody>
803
+ </table>
804
+ <p><em>Options supported by sow_and_delta_subscribe</em></p>
805
+ </div>
806
+ <div class="section" id="id3">
807
+ <h3>Returns<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h3>
808
+ <p>A <code class="docutils literal"><span class="pre">sow_and_delta_subscribe</span></code> command returns the following command types:</p>
809
+ <table border="1" class="docutils">
810
+ <colgroup>
811
+ <col width="50%" />
812
+ <col width="50%" />
813
+ </colgroup>
814
+ <thead valign="bottom">
815
+ <tr class="row-odd"><th class="head"><strong>Command</strong></th>
816
+ <th class="head"><em>Description</em></th>
817
+ </tr>
818
+ </thead>
819
+ <tbody valign="top">
820
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">group_begin</span></code></td>
821
+ <td>Indicates the beginning of results from a
822
+ SOW query.</td>
823
+ </tr>
824
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">group_end</span></code></td>
825
+ <td>Indicates the end of results from a SOW
826
+ query.</td>
827
+ </tr>
828
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">sow</span></code></td>
829
+ <td>Indicates a record returned from a SOW query</td>
830
+ </tr>
831
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">publish</span></code></td>
832
+ <td>A new message or update published to AMPS.</td>
833
+ </tr>
834
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">oof</span></code></td>
835
+ <td>Returned when the <code class="docutils literal"><span class="pre">oof</span></code> option is requested
836
+ on the command, the subscription is to a topic
837
+ in the State of the World, and the subscription
838
+ is not a bookmark subscribe.</td>
839
+ </tr>
840
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">ack</span></code></td>
841
+ <td>Acknowledgements requested, as described
842
+ in the following section.</td>
843
+ </tr>
844
+ </tbody>
845
+ </table>
846
+ <p><em>Command types returned by sow_and_delta_subscribe</em></p>
847
+ <p>AMPS will send acknowledgment messages for the following <code class="docutils literal"><span class="pre">AckType</span></code>
848
+ fields: <code class="docutils literal"><span class="pre">received</span></code> and <code class="docutils literal"><span class="pre">processed</span></code>, along with a populated
849
+ <code class="docutils literal"><span class="pre">Status</span></code> header field describing the acknowledgment message.</p>
850
+ <p>If the <code class="docutils literal"><span class="pre">sow_and_delta_subscribe</span></code> command is successful, AMPS will
851
+ return a <code class="docutils literal"><span class="pre">group_begin</span></code> message to notify the client that a group of
852
+ messages is being returned as part of the <code class="docutils literal"><span class="pre">sow</span></code> portion of the
853
+ command. The <em>SOW Queries</em> chapter in the <em>AMPS User Guide</em> provides
854
+ more information about SOW topic query behavior.
855
+ The following table
856
+ contains the <code class="docutils literal"><span class="pre">AckType</span></code> messages which can be returned by a
857
+ <code class="docutils literal"><span class="pre">sow_and_delta_subscribe</span></code>.</p>
858
+ <table border="1" class="docutils" id="command-sow-and-delta-subscribe-acks">
859
+ <colgroup>
860
+ <col width="50%" />
861
+ <col width="50%" />
862
+ </colgroup>
863
+ <thead valign="bottom">
864
+ <tr class="row-odd"><th class="head"><strong>Acknowledgment</strong></th>
865
+ <th class="head"><strong>Description</strong></th>
866
+ </tr>
867
+ </thead>
868
+ <tbody valign="top">
869
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">none</span></code></td>
870
+ <td>No <code class="docutils literal"><span class="pre">ack</span></code> message is returned. This is the
871
+ default behavior.</td>
872
+ </tr>
873
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">completed</span></code></td>
874
+ <td>The <code class="docutils literal"><span class="pre">sow_and_delta_subscribe</span></code> message has
875
+ completed the <code class="docutils literal"><span class="pre">sow</span></code> portion of the command,
876
+ and all future messages will be updated based on
877
+ publishes.</td>
878
+ </tr>
879
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">persisted</span></code></td>
880
+ <td>Not supported at this time.</td>
881
+ </tr>
882
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">processed</span></code></td>
883
+ <td>AMPS has compiled the filter(s) for the
884
+ <code class="docutils literal"><span class="pre">sow_and_delta_subscribe</span></code> message(s).</td>
885
+ </tr>
886
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">received</span></code></td>
887
+ <td>The <code class="docutils literal"><span class="pre">sow_and_delta_subscribe</span></code> message has been
888
+ received.</td>
889
+ </tr>
890
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">stats</span></code></td>
891
+ <td>Returns an <code class="docutils literal"><span class="pre">ack</span></code> message with <code class="docutils literal"><span class="pre">Matches</span></code>,
892
+ <code class="docutils literal"><span class="pre">TopicMatches</span></code> and <code class="docutils literal"><span class="pre">RecordsReturned</span></code>.</td>
893
+ </tr>
894
+ </tbody>
895
+ </table>
896
+ <p><em>Acknowledgment messages supported by sow_and_delta_subscribe</em></p>
897
+ <p>The <code class="docutils literal"><span class="pre">stats</span></code> acknowledgment message includes three values in the
898
+ header, the <code class="docutils literal"><span class="pre">Matches</span></code>, <code class="docutils literal"><span class="pre">TopicMatches</span></code> and the <code class="docutils literal"><span class="pre">RecordsReturned</span></code>.
899
+ These are defined below:</p>
900
+ <div class="section" id="topicmatches">
901
+ <h4>TopicMatches<a class="headerlink" href="#topicmatches" title="Permalink to this headline">¶</a></h4>
902
+ <p>The total number of records compared across all matching SOW topics.</p>
903
+ </div>
904
+ <div class="section" id="matches">
905
+ <h4>Matches<a class="headerlink" href="#matches" title="Permalink to this headline">¶</a></h4>
906
+ <p>The number of records returned that match the topic regular expression
907
+ and the content filter. This value can be greater than
908
+ <code class="docutils literal"><span class="pre">RecordsReturned</span></code> in the case where the number of returned records is
909
+ limited by <code class="docutils literal"><span class="pre">TopN</span></code>.</p>
910
+ </div>
911
+ <div class="section" id="recordsreturned">
912
+ <h4>RecordsReturned<a class="headerlink" href="#recordsreturned" title="Permalink to this headline">¶</a></h4>
913
+ <p>The total number of records returned to the client, which can be limited
914
+ by the <code class="docutils literal"><span class="pre">TopN</span></code> header value.</p>
915
+ </div>
916
+ </div>
917
+ <div class="section" id="id4">
918
+ <h3>Errors<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h3>
919
+ <p>Errors for a <code class="docutils literal"><span class="pre">sow_and_delta_subscribe</span></code> query are either returned in
920
+ the <code class="docutils literal"><span class="pre">Status</span></code> field if an <code class="docutils literal"><span class="pre">AckType</span></code> has been defined, or the errors
921
+ may be inserted into the AMPS log.</p>
922
+ </div>
923
+ </div>
924
+ <div class="section" id="sow-and-subscribe">
925
+ <h2>sow_and_subscribe<a class="headerlink" href="#sow-and-subscribe" title="Permalink to this headline">¶</a></h2>
926
+ <p>A <code class="docutils literal"><span class="pre">sow_and_subscribe</span></code> command is used to combine the functionality of
927
+ <code class="docutils literal"><span class="pre">sow</span></code> and a <code class="docutils literal"><span class="pre">subscribe</span></code> command in a single command.</p>
928
+ <p>The <code class="docutils literal"><span class="pre">sow_and_subscribe</span></code> command is used (a) to query the contents of a
929
+ SOW topic (this is the <code class="docutils literal"><span class="pre">sow</span></code> command); and (b) to place a subscription
930
+ such that any messages matching the subscribed SOW topic and query
931
+ filter will be published to the AMPS client (this is the <code class="docutils literal"><span class="pre">subscribe</span></code>
932
+ command). As with the <code class="docutils literal"><span class="pre">subscribe</span></code> command, <code class="docutils literal"><span class="pre">publish</span></code> messages
933
+ representing updates to SOW records are provided for records
934
+ that match the filter when there is an update published to that
935
+ record.</p>
936
+ <div class="section" id="id5">
937
+ <h3>Header Fields<a class="headerlink" href="#id5" title="Permalink to this headline">¶</a></h3>
938
+ <p>The following table
939
+ contains the header fields supported by a <code class="docutils literal"><span class="pre">sow_and_subscribe</span></code> command.</p>
940
+ <table border="1" class="docutils" id="command-sow-and-subscribe-headers">
941
+ <colgroup>
942
+ <col width="50%" />
943
+ <col width="50%" />
944
+ </colgroup>
945
+ <thead valign="bottom">
946
+ <tr class="row-odd"><th class="head"><strong>Field</strong></th>
947
+ <th class="head"><strong>Description</strong></th>
948
+ </tr>
949
+ </thead>
950
+ <tbody valign="top">
951
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">Command</span></code></td>
952
+ <td>The command to be executed. Value:
953
+ <code class="docutils literal"><span class="pre">sow_and_subscribe</span></code>.</td>
954
+ </tr>
955
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">Topic</span></code></td>
956
+ <td>The target SOW topic to query and subscribe.</td>
957
+ </tr>
958
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">AckType</span></code></td>
959
+ <td>Acknowledgment type for the given command. Value
960
+ is a comma separated string of one of more of
961
+ the following: <code class="docutils literal"><span class="pre">none</span></code>, <code class="docutils literal"><span class="pre">received</span></code>,
962
+ <code class="docutils literal"><span class="pre">processed</span></code>, <code class="docutils literal"><span class="pre">completed</span></code> or <code class="docutils literal"><span class="pre">stats</span></code>.</td>
963
+ </tr>
964
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">BatchSize</span></code></td>
965
+ <td>Number of records to return in a single sow
966
+ query results message. While the default value
967
+ is 1, it is recommended to use a higher value,
968
+ as even small increases can yield greater
969
+ performance in query result delivery.</td>
970
+ </tr>
971
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">Bookmark</span></code></td>
972
+ <td><p class="first">A bookmark specifying the historical state of
973
+ the SOW to return results from. For SOW topics
974
+ where historical query is enabled, AMPS returns
975
+ the saved state of the SOW as of that bookmark.
976
+ For SOW topics where historical query is not
977
+ enabled, AMPS ignores this parameter.</p>
978
+ <p class="last">If the topic is enabled for historical query and
979
+ AMPS has a transaction log that covers the
980
+ topic, AMPS returns the saved state of the SOW
981
+ as of that bookmark and starts a bookmark
982
+ subscription at a point in the transaction log
983
+ immediately after the point at which the SOW
984
+ state was saved. In other words, if the
985
+ granularity of the historical SOW preserves the
986
+ state of the SOW at 11:30:10 AM and 11:30:50 AM,
987
+ a request for a bookmark at 11:30:20 AM will
988
+ provide the SOW state as of 11:30:10 AM, and
989
+ begin the replay immediately after that SOW
990
+ state. This ensures no messages are missed, but
991
+ means that the subscription may begin before the
992
+ bookmark.</p>
993
+ </td>
994
+ </tr>
995
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">CommandId</span></code></td>
996
+ <td>If specified with an AMPS command requesting an
997
+ acknowledgment message, all <code class="docutils literal"><span class="pre">ack</span></code> messages
998
+ will contain the <code class="docutils literal"><span class="pre">CommandId</span></code> in the
999
+ acknowledgment message.</td>
1000
+ </tr>
1001
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">DataOnly</span></code></td>
1002
+ <td>Only send raw data to subscriber for a matching
1003
+ <code class="docutils literal"><span class="pre">publish</span></code> message if <code class="docutils literal"><span class="pre">true</span></code>. For example:
1004
+ this will remove the SOAP envelope in an XML
1005
+ message.</td>
1006
+ </tr>
1007
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">Filter</span></code></td>
1008
+ <td>Content filter expression.</td>
1009
+ </tr>
1010
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">Options</span></code></td>
1011
+ <td>A comma separated list of flags available to the
1012
+ <code class="docutils literal"><span class="pre">sow_and_subscribe</span></code> command.
1013
+ <a class="reference internal" href="#command-sow-and-subscribe-options"><span class="std std-ref">Table &#8220;Options types supported by sow_and_subscribe&#8221;</span></a>
1014
+ describes the options available.</td>
1015
+ </tr>
1016
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">OrderBy</span></code></td>
1017
+ <td>Return the SOW results sorted by the specified
1018
+ fields. Fields are a comma-delimited list of
1019
+ AMPS identifiers, and may optionally include a
1020
+ sort specifier, <code class="docutils literal"><span class="pre">ASC</span></code> or <code class="docutils literal"><span class="pre">DESC</span></code>.</td>
1021
+ </tr>
1022
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">QueryId</span></code></td>
1023
+ <td>Identifier used to identify the client&#8217;s SOW
1024
+ topic query. This identifier will be added to
1025
+ all messages representing a response to the
1026
+ <code class="docutils literal"><span class="pre">sow_and_subscribe</span></code> command.</td>
1027
+ </tr>
1028
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">SendOOF</span></code></td>
1029
+ <td>Messages that have fallen out of focus from the
1030
+ subscription are sent to the client. Default is
1031
+ <code class="docutils literal"><span class="pre">false</span></code>.</td>
1032
+ </tr>
1033
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">SendKeys</span></code></td>
1034
+ <td>Option to instruct AMPS that the client would
1035
+ like to receive the <code class="docutils literal"><span class="pre">SowKey</span></code> back.</td>
1036
+ </tr>
1037
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">SendSubscriptionIds</span></code></td>
1038
+ <td>If <code class="docutils literal"><span class="pre">true</span></code>, subscription identifiers will be
1039
+ sent for a matched message.</td>
1040
+ </tr>
1041
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">SowKeys</span></code></td>
1042
+ <td>A comma-delimited list of <code class="docutils literal"><span class="pre">SowKeys</span></code> that
1043
+ identify the messages to return from the query.</td>
1044
+ </tr>
1045
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">SubscriptionId</span></code></td>
1046
+ <td><p class="first">The subscription ID for this command. When
1047
+ provided with a new subscription, this is the
1048
+ identifier that AMPS will use for the
1049
+ subscription. When provided with the <code class="docutils literal"><span class="pre">replace</span></code>
1050
+ option, this field specifies the subscription to
1051
+ replace. When provided with a <code class="docutils literal"><span class="pre">pause</span></code> or
1052
+ <code class="docutils literal"><span class="pre">resume</span></code> option, this field specifies the
1053
+ subscriptions to pause or resume.</p>
1054
+ <p class="last">For a new subscription, the AMPS clients will
1055
+ generate a subscription ID if one is not
1056
+ provided.</p>
1057
+ </td>
1058
+ </tr>
1059
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">TopN</span></code></td>
1060
+ <td>Return up to the number of messages specified
1061
+ from the SOW query.</td>
1062
+ </tr>
1063
+ </tbody>
1064
+ </table>
1065
+ <p><em>Header fields supported by sow_and_subscribe</em></p>
1066
+ </div>
1067
+ <div class="section" id="id6">
1068
+ <h3>Returns<a class="headerlink" href="#id6" title="Permalink to this headline">¶</a></h3>
1069
+ <p>A <code class="docutils literal"><span class="pre">sow_and_subscribe</span></code> command returns the following command types:</p>
1070
+ <table border="1" class="docutils">
1071
+ <colgroup>
1072
+ <col width="50%" />
1073
+ <col width="50%" />
1074
+ </colgroup>
1075
+ <thead valign="bottom">
1076
+ <tr class="row-odd"><th class="head"><strong>Command</strong></th>
1077
+ <th class="head"><em>Description</em></th>
1078
+ </tr>
1079
+ </thead>
1080
+ <tbody valign="top">
1081
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">group_begin</span></code></td>
1082
+ <td>Indicates the beginning of results from a
1083
+ SOW query.</td>
1084
+ </tr>
1085
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">group_end</span></code></td>
1086
+ <td>Indicates the end of results from a SOW
1087
+ query.</td>
1088
+ </tr>
1089
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">sow</span></code></td>
1090
+ <td>Indicates a record returned from a SOW query</td>
1091
+ </tr>
1092
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">publish</span></code></td>
1093
+ <td>A new message or update published to AMPS.</td>
1094
+ </tr>
1095
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">oof</span></code></td>
1096
+ <td>Returned when the <code class="docutils literal"><span class="pre">oof</span></code> option is requested
1097
+ on the command, the subscription is to a topic
1098
+ in the State of the World, and the subscription
1099
+ is not a bookmark subscribe.</td>
1100
+ </tr>
1101
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">ack</span></code></td>
1102
+ <td>Acknowledgements requested, as described
1103
+ in the following section.</td>
1104
+ </tr>
1105
+ </tbody>
1106
+ </table>
1107
+ <p><em>Command types returned by sow_and_subscribe</em></p>
1108
+ <p>AMPS will send acknowledgment messages for the following <code class="docutils literal"><span class="pre">AckType</span></code>
1109
+ fields: <code class="docutils literal"><span class="pre">received</span></code>, <code class="docutils literal"><span class="pre">processed</span></code> along with a populated <code class="docutils literal"><span class="pre">Status</span></code>
1110
+ header field describing the acknowledgment message.</p>
1111
+ <p>If the <code class="docutils literal"><span class="pre">sow_and_subscribe</span></code> command is successful, AMPS will return a
1112
+ <code class="docutils literal"><span class="pre">group_begin</span></code> message to notify the client that a group of messages is
1113
+ being returned as part of the <code class="docutils literal"><span class="pre">sow</span></code> portion of the command.</p>
1114
+ <p>The <em>SOW Queries</em> chapter in the <em>AMPS User Guide</em> will provide more
1115
+ information about SOW topic query behavior.
1116
+ The following table
1117
+ contains the <code class="docutils literal"><span class="pre">AckType</span></code> messages that can be returned by a <code class="docutils literal"><span class="pre">sow_and_subscribe</span></code>.</p>
1118
+ <table border="1" class="docutils" id="command-sow-and-subscribe-acks">
1119
+ <colgroup>
1120
+ <col width="50%" />
1121
+ <col width="50%" />
1122
+ </colgroup>
1123
+ <thead valign="bottom">
1124
+ <tr class="row-odd"><th class="head"><strong>Acknowledgment</strong></th>
1125
+ <th class="head"><strong>Description</strong></th>
1126
+ </tr>
1127
+ </thead>
1128
+ <tbody valign="top">
1129
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">none</span></code></td>
1130
+ <td>No <code class="docutils literal"><span class="pre">ack</span></code> message is returned. This is the
1131
+ default behavior.</td>
1132
+ </tr>
1133
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">bookmark</span></code></td>
1134
+ <td><p class="first">Specifies that the subscription should return
1135
+ bookmarks, if available, on each publish
1136
+ message. Bookmarks are only available if the
1137
+ topic that is subscribed to is recorded in the
1138
+ transaction log.</p>
1139
+ <p>Notice that this option does not set the
1140
+ starting point for a bookmark subscription: use
1141
+ the <code class="docutils literal"><span class="pre">Bookmark</span></code> header for that purpose.</p>
1142
+ <p class="last">This option is not required to receive bookmarks
1143
+ for a bookmark subscription. Those subscriptions
1144
+ always include bookmarks on each publish message.</p>
1145
+ </td>
1146
+ </tr>
1147
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">completed</span></code></td>
1148
+ <td>The <code class="docutils literal"><span class="pre">sow_and_subscribe</span></code> message has completed
1149
+ the <code class="docutils literal"><span class="pre">sow</span></code> portion of the command, and all
1150
+ future messages will be updated based on
1151
+ publishes.</td>
1152
+ </tr>
1153
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">persisted</span></code></td>
1154
+ <td>Not supported at this time.</td>
1155
+ </tr>
1156
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">processed</span></code></td>
1157
+ <td>AMPS has completed the work necessary to
1158
+ register the subscription and begin the SOW
1159
+ query.</td>
1160
+ </tr>
1161
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">received</span></code></td>
1162
+ <td>The <code class="docutils literal"><span class="pre">sow_and_subscribe</span></code> message has been
1163
+ received.</td>
1164
+ </tr>
1165
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">stats</span></code></td>
1166
+ <td>Returns an <code class="docutils literal"><span class="pre">ack</span></code> message with <code class="docutils literal"><span class="pre">Matches</span></code>,
1167
+ <code class="docutils literal"><span class="pre">TopicMatches</span></code> and <code class="docutils literal"><span class="pre">RecordsReturned</span></code>.</td>
1168
+ </tr>
1169
+ </tbody>
1170
+ </table>
1171
+ <p><em>Acknowledgment messages supported by sow_and_subscribe</em></p>
1172
+ <p>The <code class="docutils literal"><span class="pre">stats</span></code> acknowledgment message includes three values in the
1173
+ header, the <code class="docutils literal"><span class="pre">Matches</span></code>, <code class="docutils literal"><span class="pre">TopicMatches</span></code> and the <code class="docutils literal"><span class="pre">RecordsReturned</span></code>.
1174
+ These are defined below:</p>
1175
+ <div class="section" id="id7">
1176
+ <h4>TopicMatches<a class="headerlink" href="#id7" title="Permalink to this headline">¶</a></h4>
1177
+ <p>The total number of records compared across all matching SOW topics.</p>
1178
+ </div>
1179
+ <div class="section" id="id8">
1180
+ <h4>Matches<a class="headerlink" href="#id8" title="Permalink to this headline">¶</a></h4>
1181
+ <p>The number of records returned that match the topic regular expression
1182
+ and the content filter. This value can be greater than
1183
+ <code class="docutils literal"><span class="pre">RecordsReturned</span></code> in the case where the number of returned records is
1184
+ limited by <code class="docutils literal"><span class="pre">TopN</span></code>.</p>
1185
+ </div>
1186
+ <div class="section" id="id9">
1187
+ <h4>RecordsReturned<a class="headerlink" href="#id9" title="Permalink to this headline">¶</a></h4>
1188
+ <p>The total number of records returned to the client, which can be limited
1189
+ by the <code class="docutils literal"><span class="pre">TopN</span></code> header value.</p>
1190
+ </div>
1191
+ </div>
1192
+ <div class="section" id="id10">
1193
+ <h3>Options Field<a class="headerlink" href="#id10" title="Permalink to this headline">¶</a></h3>
1194
+ <p>The following table
1195
+ contains a list of the <code class="docutils literal"><span class="pre">Options</span></code> available and their definitions when used in the AMPS
1196
+ <code class="docutils literal"><span class="pre">sow_and_subscribe</span></code> command.</p>
1197
+ <table border="1" class="docutils" id="command-sow-and-subscribe-options">
1198
+ <colgroup>
1199
+ <col width="50%" />
1200
+ <col width="50%" />
1201
+ </colgroup>
1202
+ <thead valign="bottom">
1203
+ <tr class="row-odd"><th class="head"><strong>Option</strong></th>
1204
+ <th class="head"><strong>Description</strong></th>
1205
+ </tr>
1206
+ </thead>
1207
+ <tbody valign="top">
1208
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">none</span></code></td>
1209
+ <td>This is the default <code class="docutils literal"><span class="pre">Options</span></code> type.</td>
1210
+ </tr>
1211
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">conflation=n</span></code></td>
1212
+ <td><p class="first">Specifies whether to conflate this
1213
+ subscription.The value provided can be a time
1214
+ interval, <code class="docutils literal"><span class="pre">auto</span></code>, or <code class="docutils literal"><span class="pre">none</span></code></p>
1215
+ <p>When present and set to a value other than none,
1216
+ enables conflation for the subscription.</p>
1217
+ <p>Can also be set to <code class="docutils literal"><span class="pre">auto</span></code>, which requests that
1218
+ AMPS attempt to determine an appropriate
1219
+ conflation interval based on client consumption.</p>
1220
+ <p>Recognizes the same time specifiers used in the
1221
+ AMPS configuration file (for example, <code class="docutils literal"><span class="pre">100ms</span></code>
1222
+ or <code class="docutils literal"><span class="pre">1s</span></code> or <code class="docutils literal"><span class="pre">1m</span></code>).</p>
1223
+ <p class="last">Defaults to <code class="docutils literal"><span class="pre">none</span></code>.</p>
1224
+ </td>
1225
+ </tr>
1226
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">conflation_key=[key]</span></code></td>
1227
+ <td><p class="first">When conflation is enabled, specifies the fields
1228
+ to use to determine message uniqueness. The
1229
+ format of this option is a comma-delimited list
1230
+ of XPath identifiers within brackets. For
1231
+ example, to conflate based on the value of the
1232
+ <code class="docutils literal"><span class="pre">/tickerId</span></code> and <code class="docutils literal"><span class="pre">/customerId</span></code> within a
1233
+ message the value of this option would be
1234
+ <code class="docutils literal"><span class="pre">[/tickerId,/customerId]</span></code>.</p>
1235
+ <p>Defaults to the SOW key fields for SOW topics.
1236
+ No default for non-SOW topics. This option is
1237
+ required for non-SOW topics.</p>
1238
+ <p class="last">This option is not valid with the <code class="docutils literal"><span class="pre">oof</span></code> option
1239
+ unless the keys provided are the same as the
1240
+ keys for the underlying topic.</p>
1241
+ </td>
1242
+ </tr>
1243
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">grouping=[keys]</span></code></td>
1244
+ <td><p class="first">For use with aggregated subscriptions.</p>
1245
+ <p>The format of this option is a comma-delimited
1246
+ list of XPath identifiers within brackets. For
1247
+ example, to aggregate entries based on their
1248
+ <code class="docutils literal"><span class="pre">/description</span></code> (producing one record in the
1249
+ aggregation for each distinct value in
1250
+ <code class="docutils literal"><span class="pre">/description</span></code>), you would use the following
1251
+ option:</p>
1252
+ <p>This option must contain an entry for every
1253
+ field in the aggregated message. If there is no
1254
+ entry for a field in this option, that field
1255
+ will not appear in the aggregated message, even
1256
+ if the field is in the underlying message.</p>
1257
+ <p class="last">When this option is provided, a <code class="docutils literal"><span class="pre">projection</span></code>
1258
+ must also be provided. This option cannot be
1259
+ used with a bookmark.</p>
1260
+ </td>
1261
+ </tr>
1262
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">live</span></code></td>
1263
+ <td>Tells AMPS to send messages to subscribing
1264
+ clients before they have been persisted to the
1265
+ transaction log. This option is only valid for
1266
+ bookmark subscriptions.</td>
1267
+ </tr>
1268
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">no_sowkey</span></code></td>
1269
+ <td>Tells AMPS not to send the AMPS-generated
1270
+ <code class="docutils literal"><span class="pre">SowKey</span></code> for messages.</td>
1271
+ </tr>
1272
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">non_regex_topic</span></code></td>
1273
+ <td>Specifies that the topic name should be a literal
1274
+ match, even if the topic name contains
1275
+ regular expression characters.</td>
1276
+ </tr>
1277
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">oof</span></code></td>
1278
+ <td>Send on <code class="docutils literal"><span class="pre">OOF</span></code> message for records which have
1279
+ fallen out of focus from the original
1280
+ subscription.</td>
1281
+ </tr>
1282
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">pause</span></code></td>
1283
+ <td>Pause a bookmark subscription. This option is
1284
+ only valid for bookmark subscriptions that do
1285
+ not use the <code class="docutils literal"><span class="pre">live</span></code> option. When this option is
1286
+ present, AMPS pauses the subscription or
1287
+ subscriptions provided in the <code class="docutils literal"><span class="pre">SubId</span></code> of the
1288
+ command.</td>
1289
+ </tr>
1290
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">projection[fields]</span></code></td>
1291
+ <td><p class="first">For use with aggregated subscriptions.</p>
1292
+ <p>Specifies a comma-delimited set of fields to
1293
+ project, within brackets. Each entry has the
1294
+ format described in the AMPS User Guide.</p>
1295
+ <p>This option must contain an entry for every
1296
+ field in the aggregated message. If there is no
1297
+ entry for a field in this option, that field
1298
+ will not appear in the aggregated message, even
1299
+ if the field is in the underlying message.</p>
1300
+ <p>There is no default for this option. When this
1301
+ option is provided, a <code class="docutils literal"><span class="pre">grouping</span></code> must also be
1302
+ provided. This option cannot be used with a
1303
+ bookmark.</p>
1304
+ <p class="last">The maximum size of this option is 64KB.</p>
1305
+ </td>
1306
+ </tr>
1307
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">rate=n</span></code></td>
1308
+ <td>Set the maximum message delivery rate for a
1309
+ bookmark subscription. This option is only valid
1310
+ for bookmark subscriptions that do not use the
1311
+ <code class="docutils literal"><span class="pre">live</span></code> option. The rate can be specified as
1312
+ either the number of messages per second (for
1313
+ example, <code class="docutils literal"><span class="pre">1000</span></code>), the number of bytes per
1314
+ second (for example, <code class="docutils literal"><span class="pre">100KB</span></code>), or a multiple
1315
+ of the original replay rate (for example,
1316
+ <code class="docutils literal"><span class="pre">1.5X</span></code>).</td>
1317
+ </tr>
1318
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">replace</span></code></td>
1319
+ <td>Replace the subscription associated with
1320
+ <code class="docutils literal"><span class="pre">CmdId</span></code> with another subscription. When
1321
+ provided as part of <code class="docutils literal"><span class="pre">sow_and_subscribe</span></code>, AMPS
1322
+ runs a SOW query for the new subscription.</td>
1323
+ </tr>
1324
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">resume</span></code></td>
1325
+ <td>Resume a bookmark subscription. This option is
1326
+ only valid for bookmark subscriptions that do
1327
+ not use the <code class="docutils literal"><span class="pre">live</span></code> option. When this option is
1328
+ present, AMPS resumes the subscription or
1329
+ subscriptions provided in the <code class="docutils literal"><span class="pre">SubId</span></code> of the
1330
+ command.</td>
1331
+ </tr>
1332
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">top_n=n</span></code></td>
1333
+ <td>AMPS will provide at most <code class="docutils literal"><span class="pre">n</span></code> records, starting
1334
+ at the beginning of the result set as defined by
1335
+ the <code class="docutils literal"><span class="pre">OrderBy</span></code> header. This option is equivalent
1336
+ to providing a <code class="docutils literal"><span class="pre">TopN</span></code> header.</td>
1337
+ </tr>
1338
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">skip_n=n</span></code></td>
1339
+ <td>AMPS will skip the specified number of records
1340
+ in the result set before returning results.
1341
+ This option is used with the <code class="docutils literal"><span class="pre">top_n</span></code> option
1342
+ to create a paginated subscription.</td>
1343
+ </tr>
1344
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">send_keys</span></code></td>
1345
+ <td>AMPS will send the SOW keys (that is, the data
1346
+ fields used to identify unique messages in the
1347
+ SOW) back with matching messages from the SOW.</td>
1348
+ </tr>
1349
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">select</span></code></td>
1350
+ <td>Specifies the fields to include in messages
1351
+ provided on this subscription. The contents of
1352
+ this option are a comma-delimited list of
1353
+ inclusion specifiers.</td>
1354
+ </tr>
1355
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">timestamp</span></code></td>
1356
+ <td>AMPS will include a header with the time at
1357
+ which this instance of AMPS processed the
1358
+ incoming publish command for this message.</td>
1359
+ </tr>
1360
+ </tbody>
1361
+ </table>
1362
+ <p><em>Options types supported by sow_and_subscribe</em></p>
1363
+ </div>
1364
+ <div class="section" id="id11">
1365
+ <h3>Errors<a class="headerlink" href="#id11" title="Permalink to this headline">¶</a></h3>
1366
+ <p>Errors for a <code class="docutils literal"><span class="pre">sow_and_subscribe</span></code> query are either returned in the
1367
+ <code class="docutils literal"><span class="pre">Status</span></code> field if an <code class="docutils literal"><span class="pre">AckType</span></code> has been defined, or the errors may
1368
+ be inserted into the AMPS log.</p>
1369
+ </div>
1370
+ </div>
1371
+ <div class="section" id="subscribe">
1372
+ <h2>subscribe<a class="headerlink" href="#subscribe" title="Permalink to this headline">¶</a></h2>
1373
+ <p>The <code class="docutils literal"><span class="pre">subscribe</span></code> command is the primary way to retrieve messages from
1374
+ the AMPS processing stream. A client can issue a <code class="docutils literal"><span class="pre">subscribe</span></code> command
1375
+ on a topic to receive all published messages to that topic in the
1376
+ future. Additionally, content filtering can be used to choose which
1377
+ messages the client is interested in receiving.</p>
1378
+ <div class="section" id="id12">
1379
+ <h3>Header Fields<a class="headerlink" href="#id12" title="Permalink to this headline">¶</a></h3>
1380
+ <table border="1" class="docutils" id="command-subscribe-headers">
1381
+ <colgroup>
1382
+ <col width="50%" />
1383
+ <col width="50%" />
1384
+ </colgroup>
1385
+ <thead valign="bottom">
1386
+ <tr class="row-odd"><th class="head"><strong>Field</strong></th>
1387
+ <th class="head"><strong>Description</strong></th>
1388
+ </tr>
1389
+ </thead>
1390
+ <tbody valign="top">
1391
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">Command</span></code></td>
1392
+ <td>Command to be executed. Value: <code class="docutils literal"><span class="pre">subscribe</span></code>.</td>
1393
+ </tr>
1394
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">Topic</span></code></td>
1395
+ <td>Topic to place a subscription against.</td>
1396
+ </tr>
1397
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">AckType</span></code></td>
1398
+ <td>Acknowledgment type for the given command. Value
1399
+ is a comma separated list of one or more of the
1400
+ following: <code class="docutils literal"><span class="pre">none</span></code>, <code class="docutils literal"><span class="pre">received</span></code>, <code class="docutils literal"><span class="pre">processed</span></code>
1401
+ or <code class="docutils literal"><span class="pre">completed</span></code>.</td>
1402
+ </tr>
1403
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">Bookmark</span></code></td>
1404
+ <td>A bookmark specifying the point in the
1405
+ transaction log at which to start the
1406
+ subscription. If the topic provided is not
1407
+ recorded in a transaction log, AMPS enters the
1408
+ subscription without replaying messages. You can
1409
+ provide a single bookmark, or a comma-delimited
1410
+ list of bookmarks. When a list is provided, AMPS
1411
+ starts the subscription at the earliest bookmark
1412
+ in the list.</td>
1413
+ </tr>
1414
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">CommandId</span></code></td>
1415
+ <td>If specified with an AMPS command requesting an
1416
+ acknowledgment message, all requested
1417
+ acknowledgment messages will contain the
1418
+ <code class="docutils literal"><span class="pre">CommandId</span></code> in the <code class="docutils literal"><span class="pre">ack</span></code> response header.</td>
1419
+ </tr>
1420
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">DataOnly</span></code></td>
1421
+ <td>A Boolean value (<code class="docutils literal"><span class="pre">true</span></code> or <code class="docutils literal"><span class="pre">false</span></code>) which,
1422
+ if <code class="docutils literal"><span class="pre">true</span></code>, will send only raw data to
1423
+ subscriber for a matching publish message. In
1424
+ the case where the message type is XML, the SOAP
1425
+ envelope will not be included.</td>
1426
+ </tr>
1427
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">Filter</span></code></td>
1428
+ <td>A CDATA wrapped string, used as a content filter
1429
+ expression.</td>
1430
+ </tr>
1431
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">Options</span></code></td>
1432
+ <td>A comma separated list of flags available to the
1433
+ <code class="docutils literal"><span class="pre">subscribe</span></code> command.
1434
+ <a class="reference internal" href="#command-subscribe-options"><span class="std std-ref">Table 4.11</span></a>
1435
+ describes the <code class="docutils literal"><span class="pre">Options</span></code> available for use in
1436
+ the <code class="docutils literal"><span class="pre">subscribe</span></code> command.</td>
1437
+ </tr>
1438
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">SendSubscriptionIds</span></code></td>
1439
+ <td>Boolean (<code class="docutils literal"><span class="pre">true</span></code> or <code class="docutils literal"><span class="pre">false</span></code>) that tells if
1440
+ <code class="docutils literal"><span class="pre">true</span></code> requests AMPS to send subscription
1441
+ identifiers with a matched message.</td>
1442
+ </tr>
1443
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">SubscriptionId</span></code></td>
1444
+ <td><p class="first">The subscription ID for this command. When
1445
+ provided with a new subscription, this is the
1446
+ identifier that AMPS will use for the
1447
+ subscription. When provided with the <code class="docutils literal"><span class="pre">replace</span></code>
1448
+ option, this field specifies the subscription to
1449
+ replace. When provided with a <code class="docutils literal"><span class="pre">pause</span></code> or
1450
+ <code class="docutils literal"><span class="pre">resume</span></code> option, this field specifies the
1451
+ subscriptions to pause or resume.</p>
1452
+ <p class="last">For a new subscription, the AMPS clients will
1453
+ generate a subscription ID if one is not
1454
+ provided.</p>
1455
+ </td>
1456
+ </tr>
1457
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">TopN</span></code></td>
1458
+ <td>The maximum number of messages to provide from a
1459
+ bookmark subscription. This parameter is only
1460
+ valid for replay from the transaction log. This
1461
+ parameter is not valid if no bookmark is
1462
+ provided, if the provided bookmark is <code class="docutils literal"><span class="pre">0|1|</span></code>
1463
+ (start from now), or if the command includes the
1464
+ <code class="docutils literal"><span class="pre">live</span></code> option.</td>
1465
+ </tr>
1466
+ </tbody>
1467
+ </table>
1468
+ <p><em>Header fields supported by subscribe</em></p>
1469
+ </div>
1470
+ <div class="section" id="id13">
1471
+ <h3>Options Field<a class="headerlink" href="#id13" title="Permalink to this headline">¶</a></h3>
1472
+ <p>The following table contains a
1473
+ list of the <code class="docutils literal"><span class="pre">Options</span></code> available and their definitions when used in the AMPS <code class="docutils literal"><span class="pre">subscribe</span></code> command.</p>
1474
+ <table border="1" class="docutils" id="command-subscribe-options">
1475
+ <colgroup>
1476
+ <col width="50%" />
1477
+ <col width="50%" />
1478
+ </colgroup>
1479
+ <thead valign="bottom">
1480
+ <tr class="row-odd"><th class="head"><strong>Option</strong></th>
1481
+ <th class="head"><strong>Description</strong></th>
1482
+ </tr>
1483
+ </thead>
1484
+ <tbody valign="top">
1485
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">none</span></code></td>
1486
+ <td>This is the default <code class="docutils literal"><span class="pre">Options</span></code> type.</td>
1487
+ </tr>
1488
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">bookmark</span></code></td>
1489
+ <td><p class="first">Specifies that the subscription should return
1490
+ bookmarks, if available, on each publish
1491
+ message. Bookmarks are only available if the
1492
+ topic that is subscribed to is recorded in the
1493
+ transaction log.</p>
1494
+ <p>Notice that this option does not set the
1495
+ starting point for a bookmark subscription: use
1496
+ the <code class="docutils literal"><span class="pre">Bookmark</span></code> header for that purpose.</p>
1497
+ <p class="last">This option is not required to receive bookmarks
1498
+ for a bookmark subscription. Those subscriptions
1499
+ always include bookmarks on each publish message.</p>
1500
+ </td>
1501
+ </tr>
1502
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">conflation=n</span></code></td>
1503
+ <td><p class="first">Specifies whether to conflate this
1504
+ subscription.The value provided can be a time
1505
+ interval, <code class="docutils literal"><span class="pre">auto</span></code>, or <code class="docutils literal"><span class="pre">none</span></code></p>
1506
+ <p>When present and set to a value other than none,
1507
+ enables conflation for the subscription.</p>
1508
+ <p>Can also be set to <code class="docutils literal"><span class="pre">auto</span></code>, which requests that
1509
+ AMPS attempt to determine an appropriate
1510
+ conflation interval based on client consumption.</p>
1511
+ <p>Recognizes the same time specifiers used in the
1512
+ AMPS configuration file (for example, <code class="docutils literal"><span class="pre">100ms</span></code>
1513
+ or <code class="docutils literal"><span class="pre">1s</span></code> or <code class="docutils literal"><span class="pre">1m</span></code>).</p>
1514
+ <p class="last">Defaults to <code class="docutils literal"><span class="pre">none</span></code>.</p>
1515
+ </td>
1516
+ </tr>
1517
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">conflation_key=[keys]</span></code></td>
1518
+ <td><p class="first">When conflation is enabled, specifies the fields
1519
+ to use to determine message uniqueness. The
1520
+ format of this option is a comma-delimited list
1521
+ of XPath identifiers within brackets. For
1522
+ example, to conflate based on the value of the
1523
+ <code class="docutils literal"><span class="pre">/tickerId</span></code> and <code class="docutils literal"><span class="pre">/customerId</span></code> within a
1524
+ message the value of this option would be
1525
+ <code class="docutils literal"><span class="pre">[/tickerId,/customerId]</span></code>.</p>
1526
+ <p>Defaults to the SOW key fields for SOW topics.
1527
+ No default for non-SOW topics. This option is
1528
+ required for non-SOW topics.</p>
1529
+ <p class="last">This option is not valid with the <code class="docutils literal"><span class="pre">oof</span></code>
1530
+ option unless the keys provided are identical
1531
+ to the keys for the topic.</p>
1532
+ </td>
1533
+ </tr>
1534
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">fully_durable</span></code></td>
1535
+ <td><p class="first">Tells AMPS to send messages to subscribing
1536
+ clients only after they have been persisted to
1537
+ the local transaction log and acknowledged by
1538
+ all downstream instances that use synchronous
1539
+ replication.</p>
1540
+ <p class="last">This option is only valid for bookmark
1541
+ subscriptions.</p>
1542
+ </td>
1543
+ </tr>
1544
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">live</span></code></td>
1545
+ <td>Tells AMPS to send messages to subscribing
1546
+ clients before they have been persisted to the
1547
+ transaction log. This option is only valid for
1548
+ bookmark subscriptions.</td>
1549
+ </tr>
1550
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">max_backlog=n</span></code></td>
1551
+ <td>When subscribing to a queue, the number of
1552
+ unacknowledged messages the client is willing to
1553
+ accept at a time. AMPS will not exceed this
1554
+ number, but may choose a smaller number
1555
+ depending on the queue configuration.</td>
1556
+ </tr>
1557
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">non_regex_topic</span></code></td>
1558
+ <td>Specifies that the topic name should be a
1559
+ literal match, even if the topic name contains
1560
+ regular expression characters.</td>
1561
+ </tr>
1562
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">no_sowkey</span></code></td>
1563
+ <td>Tells AMPS not to send the AMPS-generated SowKey
1564
+ for messages.</td>
1565
+ </tr>
1566
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">oof</span></code></td>
1567
+ <td>Not supported by this command type.</td>
1568
+ </tr>
1569
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">pause</span></code></td>
1570
+ <td>Pause a bookmark subscription. This option is
1571
+ only valid for bookmark subscriptions that do
1572
+ not use the <code class="docutils literal"><span class="pre">live</span></code> option. When this option is
1573
+ present, AMPS pauses the subscription or
1574
+ subscriptions provided in the <code class="docutils literal"><span class="pre">SubId</span></code> of the
1575
+ command.</td>
1576
+ </tr>
1577
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">rate=n</span></code></td>
1578
+ <td>Set the maximum message delivery rate for a
1579
+ bookmark subscription. This option is only valid
1580
+ for bookmark subscriptions that do not use the
1581
+ <code class="docutils literal"><span class="pre">live</span></code> option. The rate can be specified as
1582
+ either the number of messages per second (for
1583
+ example, <code class="docutils literal"><span class="pre">1000</span></code>), the number of bytes per
1584
+ second (for example, <code class="docutils literal"><span class="pre">100KB</span></code>), or a multiple
1585
+ of the original replay rate (for example,
1586
+ <code class="docutils literal"><span class="pre">1.5X</span></code>).</td>
1587
+ </tr>
1588
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">rate_max_gap=n</span></code></td>
1589
+ <td>When entering a bookmark subscribe that is
1590
+ rate-limited, specify the maximum amount of
1591
+ time that AMPS will wait between messages.</td>
1592
+ </tr>
1593
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">replace</span></code></td>
1594
+ <td>Replace the subscription associated with
1595
+ <code class="docutils literal"><span class="pre">CmdId</span></code> with another subscription.</td>
1596
+ </tr>
1597
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">resume</span></code></td>
1598
+ <td>Resume a bookmark subscription. This option is
1599
+ only valid for bookmark subscriptions that do
1600
+ not use the <code class="docutils literal"><span class="pre">live</span></code> option. When this option is
1601
+ present, AMPS resumes the subscription or
1602
+ subscriptions provided in the <code class="docutils literal"><span class="pre">SubId</span></code> of the
1603
+ command.</td>
1604
+ </tr>
1605
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">select</span></code></td>
1606
+ <td>Specifies the fields to include in messages
1607
+ provided on this subscription. The contents
1608
+ of this option are a comma-delimited list of
1609
+ inclusion specifiers.</td>
1610
+ </tr>
1611
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">send_keys</span></code></td>
1612
+ <td>Not supported by this command type.</td>
1613
+ </tr>
1614
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">timestamp</span></code></td>
1615
+ <td>AMPS will include a header with the time at
1616
+ which this instance of AMPS processed the
1617
+ incoming publish command for this message.</td>
1618
+ </tr>
1619
+ </tbody>
1620
+ </table>
1621
+ <p><em>Options types supported by subscribe</em></p>
1622
+ </div>
1623
+ <div class="section" id="id14">
1624
+ <h3>Returns<a class="headerlink" href="#id14" title="Permalink to this headline">¶</a></h3>
1625
+ <p>A <code class="docutils literal"><span class="pre">subscribe</span></code> command returns the following command types:</p>
1626
+ <table border="1" class="docutils">
1627
+ <colgroup>
1628
+ <col width="50%" />
1629
+ <col width="50%" />
1630
+ </colgroup>
1631
+ <thead valign="bottom">
1632
+ <tr class="row-odd"><th class="head"><strong>Command</strong></th>
1633
+ <th class="head"><em>Description</em></th>
1634
+ </tr>
1635
+ </thead>
1636
+ <tbody valign="top">
1637
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">publish</span></code></td>
1638
+ <td>A message published to AMPS.</td>
1639
+ </tr>
1640
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">oof</span></code></td>
1641
+ <td>Returned when the <code class="docutils literal"><span class="pre">oof</span></code> option is requested
1642
+ on the command, the subscription is to a topic
1643
+ in the State of the World, and the subscription
1644
+ is not a bookmark subscribe.</td>
1645
+ </tr>
1646
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">ack</span></code></td>
1647
+ <td>Acknowledgements requested, as described
1648
+ in the following section.</td>
1649
+ </tr>
1650
+ </tbody>
1651
+ </table>
1652
+ <p><em>Command types returned by subscribe</em></p>
1653
+ <p>It is possible to specify a <code class="docutils literal"><span class="pre">processed</span></code> acknowledgment be sent back to
1654
+ the client that issued the <code class="docutils literal"><span class="pre">subscribe</span></code> command. Within this
1655
+ <code class="docutils literal"><span class="pre">processed</span></code> acknowledgment, a client can get back the result of
1656
+ placing the subscription (success or failure) and the
1657
+ <code class="docutils literal"><span class="pre">SubscriptionId</span></code>, which uniquely identifies the subscription within
1658
+ AMPS. Keeping track of the <code class="docutils literal"><span class="pre">SubscriptionId</span></code> is useful for
1659
+ unsubscribing from subscriptions and issuing SOW queries.</p>
1660
+ <p>The following table contains a list
1661
+ of the supported acknowledgment messages available to the <code class="docutils literal"><span class="pre">subscribe</span></code> command.</p>
1662
+ <table border="1" class="docutils" id="command-subscribe-acks">
1663
+ <colgroup>
1664
+ <col width="50%" />
1665
+ <col width="50%" />
1666
+ </colgroup>
1667
+ <thead valign="bottom">
1668
+ <tr class="row-odd"><th class="head"><strong>Acknowledgment</strong></th>
1669
+ <th class="head"><em>Description</em></th>
1670
+ </tr>
1671
+ </thead>
1672
+ <tbody valign="top">
1673
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">none</span></code></td>
1674
+ <td>No acknowledgment message is returned. This is
1675
+ the default behavior.</td>
1676
+ </tr>
1677
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">completed</span></code></td>
1678
+ <td><p class="first">Used by bookmark subscriptions to identify the
1679
+ point at which replay is completed.</p>
1680
+ <p class="last">When a bookmark is present on the subscribe
1681
+ request and this acknowledgment is requested,
1682
+ AMPS sends a <code class="docutils literal"><span class="pre">completed</span></code> acknowledgment
1683
+ message to indicate that bookmark replay is
1684
+ complete and the subscription has reached the
1685
+ point in the transaction log at which the
1686
+ subscribe command was received. Messages
1687
+ delivered after the <code class="docutils literal"><span class="pre">completed</span></code> ack are from
1688
+ new publishes.</p>
1689
+ </td>
1690
+ </tr>
1691
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">processed</span></code></td>
1692
+ <td>AMPS has completed the work necessary to
1693
+ register the subscription. When a bookmark is
1694
+ present and this acknowledgment is requested,
1695
+ this acknowledgment indicates that AMPS is
1696
+ about to begin replay.</td>
1697
+ </tr>
1698
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">persisted</span></code></td>
1699
+ <td>When a bookmark is present and this
1700
+ acknowledgment is requested, AMPS periodically
1701
+ sends a <code class="docutils literal"><span class="pre">persisted</span></code> acknowledgment message to
1702
+ indicate the most recent bookmark in the
1703
+ server&#8217;s transaction log.</td>
1704
+ </tr>
1705
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">received</span></code></td>
1706
+ <td>The <code class="docutils literal"><span class="pre">subscribe</span></code> message has been received.</td>
1707
+ </tr>
1708
+ </tbody>
1709
+ </table>
1710
+ <p><em>Acknowledgment messages supported by subscribe</em></p>
1711
+ </div>
1712
+ <div class="section" id="id15">
1713
+ <h3>Errors<a class="headerlink" href="#id15" title="Permalink to this headline">¶</a></h3>
1714
+ <p>Any errors that occur during this command will be returned in the status
1715
+ of a <code class="docutils literal"><span class="pre">processed</span></code> acknowledgment and logged to the log file. Regardless
1716
+ of success or failure, the processed acknowledgment will only be
1717
+ returned if requested by including <code class="docutils literal"><span class="pre">processed</span></code> in the <code class="docutils literal"><span class="pre">AckType</span></code>
1718
+ field.</p>
1719
+ </div>
1720
+ </div>
1721
+ <div class="section" id="sow">
1722
+ <h2>sow<a class="headerlink" href="#sow" title="Permalink to this headline">¶</a></h2>
1723
+ <p>The <code class="docutils literal"><span class="pre">sow</span></code> command is use to query the contents of a previously defined
1724
+ topic in the state of the world (including also views, queues, and
1725
+ conflated topics). A <code class="docutils literal"><span class="pre">sow</span></code> command can be used to query an entire SOW <code class="docutils literal"><span class="pre">Topic</span></code>,
1726
+ or a filter can be used to further refine the results from the
1727
+ State of the World. For more information, see the <em>State of the World</em> and <em>SOW
1728
+ Queries</em> chapters in the <em>AMPS User Guide</em></p>
1729
+ <div class="section" id="id16">
1730
+ <h3>Header Fields<a class="headerlink" href="#id16" title="Permalink to this headline">¶</a></h3>
1731
+ <table border="1" class="docutils" id="command-sow-headers">
1732
+ <colgroup>
1733
+ <col width="50%" />
1734
+ <col width="50%" />
1735
+ </colgroup>
1736
+ <thead valign="bottom">
1737
+ <tr class="row-odd"><th class="head"><strong>Field</strong></th>
1738
+ <th class="head"><strong>Description</strong></th>
1739
+ </tr>
1740
+ </thead>
1741
+ <tbody valign="top">
1742
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">Command</span></code></td>
1743
+ <td>Command to be executed. Value: <code class="docutils literal"><span class="pre">sow</span></code>.</td>
1744
+ </tr>
1745
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">Topic</span></code></td>
1746
+ <td>The SOW topic from which the records will be
1747
+ queried.</td>
1748
+ </tr>
1749
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">AckType</span></code></td>
1750
+ <td>Acknowledgment type for the given command. Value
1751
+ is a comma separated list of one or more of the
1752
+ following: <code class="docutils literal"><span class="pre">none</span></code>, <code class="docutils literal"><span class="pre">received</span></code>,
1753
+ <code class="docutils literal"><span class="pre">processed</span></code>, <code class="docutils literal"><span class="pre">completed</span></code> or <code class="docutils literal"><span class="pre">stats</span></code></td>
1754
+ </tr>
1755
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">BatchSize</span></code></td>
1756
+ <td>Number of records to return in a single <code class="docutils literal"><span class="pre">sow</span></code>
1757
+ query result message. While the default value is
1758
+ 1, it is recommended to use a higher
1759
+ <code class="docutils literal"><span class="pre">BatchSize</span></code> value, as even small increases can
1760
+ yield greater performance in query result
1761
+ delivery.</td>
1762
+ </tr>
1763
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">Bookmark</span></code></td>
1764
+ <td>A bookmark specifying the historical state of
1765
+ the SOW to return results from. For SOW topics
1766
+ where historical query is enabled, AMPS returns
1767
+ the saved state of the SOW as of that bookmark.
1768
+ For SOW topics where historical query is not
1769
+ enabled, AMPS ignores this parameter.</td>
1770
+ </tr>
1771
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">CommandId</span></code></td>
1772
+ <td>If specified with an AMPS command requesting an
1773
+ acknowledgment message, all requested
1774
+ acknowledgment messages will contain the
1775
+ <code class="docutils literal"><span class="pre">CommandId</span></code> in the <code class="docutils literal"><span class="pre">ack</span></code> response header.</td>
1776
+ </tr>
1777
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">Filter</span></code></td>
1778
+ <td>Content filter expression. See the <em>Content
1779
+ Filtering</em> chapter in the <em>AMPS User Guide</em> for
1780
+ more information on using content filters.</td>
1781
+ </tr>
1782
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">OrderBy</span></code></td>
1783
+ <td>Return the SOW results sorted by the specified
1784
+ fields. Fields are a comma-delimited list of
1785
+ AMPS identifiers, and may optionally include a
1786
+ sort specifier, <code class="docutils literal"><span class="pre">ASC</span></code> or <code class="docutils literal"><span class="pre">DESC</span></code>.</td>
1787
+ </tr>
1788
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">QueryId</span></code></td>
1789
+ <td>Unique identifier which is returned as part of
1790
+ the response delivered back to the client.</td>
1791
+ </tr>
1792
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">SowKeys</span></code></td>
1793
+ <td>A comma-delimited list of <code class="docutils literal"><span class="pre">SowKeys</span></code> that
1794
+ identify the messages to return from the query.</td>
1795
+ </tr>
1796
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">TopN</span></code></td>
1797
+ <td>Return up to the number of messages specified
1798
+ from the SOW query.</td>
1799
+ </tr>
1800
+ </tbody>
1801
+ </table>
1802
+ <p><em>Header fields supported by sow</em></p>
1803
+ </div>
1804
+ <div class="section" id="id17">
1805
+ <h3>Options Field<a class="headerlink" href="#id17" title="Permalink to this headline">¶</a></h3>
1806
+ <p>The following table contains a list of
1807
+ the <code class="docutils literal"><span class="pre">Options</span></code> available and their definitions when used in the AMPS <code class="docutils literal"><span class="pre">sow</span></code> command.</p>
1808
+ <table border="1" class="docutils" id="command-sow-options">
1809
+ <colgroup>
1810
+ <col width="50%" />
1811
+ <col width="50%" />
1812
+ </colgroup>
1813
+ <thead valign="bottom">
1814
+ <tr class="row-odd"><th class="head"><strong>Option</strong></th>
1815
+ <th class="head"><strong>Description</strong></th>
1816
+ </tr>
1817
+ </thead>
1818
+ <tbody valign="top">
1819
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">none</span></code></td>
1820
+ <td>This is the default <code class="docutils literal"><span class="pre">Options</span></code> type.</td>
1821
+ </tr>
1822
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">no_sowkey</span></code></td>
1823
+ <td>Tells AMPS not to send the AMPS-generated
1824
+ <code class="docutils literal"><span class="pre">SowKey</span></code> for messages.</td>
1825
+ </tr>
1826
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">grouping=[keys]</span></code></td>
1827
+ <td><p class="first">For use with aggregated SOW queries.</p>
1828
+ <p>The format of this option is a comma-delimited
1829
+ list of XPath identifiers within brackets. For
1830
+ example, to aggregate entries based on their
1831
+ <code class="docutils literal"><span class="pre">/description</span></code> (producing one record in the
1832
+ aggregation for each distinct value in
1833
+ <code class="docutils literal"><span class="pre">/description</span></code>), you would use the following
1834
+ option:</p>
1835
+ <p>This option must contain an entry for every
1836
+ field in the aggregated message. If there is no
1837
+ entry for a field in this option, that field
1838
+ will not appear in the aggregated message, even
1839
+ if the field is in the underlying message.</p>
1840
+ <p>When this option is provided, a <code class="docutils literal"><span class="pre">projection</span></code>
1841
+ must also be provided.</p>
1842
+ <p class="last">When the topic has <code class="docutils literal"><span class="pre">History</span></code> enabled, this
1843
+ option can be used with a bookmark to aggregate
1844
+ the historical state of the SOW.</p>
1845
+ </td>
1846
+ </tr>
1847
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">oof</span></code></td>
1848
+ <td>Send on <code class="docutils literal"><span class="pre">OOF</span></code> message for records which have
1849
+ fallen out of focus from the original
1850
+ subscription.</td>
1851
+ </tr>
1852
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">projection=[fields]</span></code></td>
1853
+ <td><p class="first">For use with aggregated SOW queries.</p>
1854
+ <p>Specifies a comma-delimited set of fields to
1855
+ project, within brackets. Each entry has the
1856
+ format described in the AMPS User Guide.</p>
1857
+ <p>This option must contain an entry for every
1858
+ field in the aggregated message. If there is no
1859
+ entry for a field in this option, that field
1860
+ will not appear in the aggregated message, even
1861
+ if the field is in the underlying message.</p>
1862
+ <p>There is no default for this option. When this
1863
+ option is provided, a <code class="docutils literal"><span class="pre">grouping</span></code> must also be
1864
+ provided.</p>
1865
+ <p>When the topic has <code class="docutils literal"><span class="pre">History</span></code> enabled, this
1866
+ option can be used with a bookmark to aggregate
1867
+ the historical state of the SOW.</p>
1868
+ <p class="last">The maximum size of this option is 64KB.</p>
1869
+ </td>
1870
+ </tr>
1871
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">replace</span></code></td>
1872
+ <td>Replace the subscription associated with
1873
+ <code class="docutils literal"><span class="pre">CmdId</span></code> with another subscription. When
1874
+ provided as part of <code class="docutils literal"><span class="pre">sow_and_subscribe</span></code>, AMPS
1875
+ runs a SOW query for the new subscription.</td>
1876
+ </tr>
1877
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">skip_n</span></code></td>
1878
+ <td>Skips the number of messages specified before
1879
+ returning results. A command that provides this
1880
+ option must also provide a <code class="docutils literal"><span class="pre">top_n</span></code> option (or
1881
+ header) and an <code class="docutils literal"><span class="pre">OrderBy</span></code> header.</td>
1882
+ </tr>
1883
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">top_n</span></code></td>
1884
+ <td>Return up to the number of messages specified
1885
+ from the SOW query.</td>
1886
+ </tr>
1887
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">select</span></code></td>
1888
+ <td>Specifies the fields to include in messages
1889
+ provided on this subscription. The contents of
1890
+ this option are a comma-delimited list of
1891
+ inclusion specifiers.</td>
1892
+ </tr>
1893
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">send_keys</span></code></td>
1894
+ <td>AMPS will send the SOW keys (that is, the data
1895
+ fields used to identify unique messages in the
1896
+ SOW) back with matching messages from the SOW.</td>
1897
+ </tr>
1898
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">timestamp</span></code></td>
1899
+ <td>AMPS will include a header with the time at
1900
+ which AMPS processed the incoming publish
1901
+ command for this message.</td>
1902
+ </tr>
1903
+ </tbody>
1904
+ </table>
1905
+ <p><em>Options types supported by sow</em></p>
1906
+ </div>
1907
+ <div class="section" id="id18">
1908
+ <h3>Returns<a class="headerlink" href="#id18" title="Permalink to this headline">¶</a></h3>
1909
+ <p>When a <code class="docutils literal"><span class="pre">sow</span></code> message is received, AMPS can return a <code class="docutils literal"><span class="pre">received</span></code>
1910
+ message as notification that the message has arrived. When the message
1911
+ filter has been processed, AMPS will return the <code class="docutils literal"><span class="pre">processed</span></code>
1912
+ acknowledgment message along with any errors that might have occurred.</p>
1913
+ <p>The results returned by a SOW are put into a <code class="docutils literal"><span class="pre">sow</span></code> record group by
1914
+ first sending a <code class="docutils literal"><span class="pre">group_begin</span></code> message, followed by the matching SOW
1915
+ records. A <code class="docutils literal"><span class="pre">group_end</span></code> message is used to denote the close of query
1916
+ results processing.</p>
1917
+ <p>The following table contains a listing
1918
+ of the acknowledgment messages supported by the <code class="docutils literal"><span class="pre">sow</span></code> command.</p>
1919
+ <table border="1" class="docutils" id="command-sow-acks">
1920
+ <colgroup>
1921
+ <col width="50%" />
1922
+ <col width="50%" />
1923
+ </colgroup>
1924
+ <thead valign="bottom">
1925
+ <tr class="row-odd"><th class="head"><strong>Acknowledgment</strong></th>
1926
+ <th class="head"><strong>Description</strong></th>
1927
+ </tr>
1928
+ </thead>
1929
+ <tbody valign="top">
1930
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">none</span></code></td>
1931
+ <td>No acknowledgment message is returned. This is
1932
+ the default behavior.</td>
1933
+ </tr>
1934
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">completed</span></code></td>
1935
+ <td>The <code class="docutils literal"><span class="pre">sow</span></code> command has completed.</td>
1936
+ </tr>
1937
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">persisted</span></code></td>
1938
+ <td>Not supported at this time.</td>
1939
+ </tr>
1940
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">processed</span></code></td>
1941
+ <td>AMPS has compiled the filter(s) for the <code class="docutils literal"><span class="pre">sow</span></code>
1942
+ message.</td>
1943
+ </tr>
1944
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">received</span></code></td>
1945
+ <td>The <code class="docutils literal"><span class="pre">sow</span></code> command has been received.</td>
1946
+ </tr>
1947
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">stats</span></code></td>
1948
+ <td>Returns statistics related to the state of the
1949
+ SOW query results.</td>
1950
+ </tr>
1951
+ </tbody>
1952
+ </table>
1953
+ <p><em>Acknowledgment messages returned by sow</em></p>
1954
+ <p>The stats message include three values in the header: <code class="docutils literal"><span class="pre">Matches</span></code>,
1955
+ <code class="docutils literal"><span class="pre">TopicMatches</span></code>, and the <code class="docutils literal"><span class="pre">RecordsReturned</span></code>. These are defined below:</p>
1956
+ <div class="section" id="id19">
1957
+ <h4>TopicMatches<a class="headerlink" href="#id19" title="Permalink to this headline">¶</a></h4>
1958
+ <p>The total number of records compared across all matching SOW topics.</p>
1959
+ </div>
1960
+ <div class="section" id="id20">
1961
+ <h4>Matches<a class="headerlink" href="#id20" title="Permalink to this headline">¶</a></h4>
1962
+ <p>The number of records returned that match the topic regular expression
1963
+ and the content filter. This value can be greater than
1964
+ <code class="docutils literal"><span class="pre">RecordsReturned</span></code> in the case where the number of returned records is
1965
+ limited by <code class="docutils literal"><span class="pre">TopN</span></code>.</p>
1966
+ </div>
1967
+ <div class="section" id="id21">
1968
+ <h4>RecordsReturned<a class="headerlink" href="#id21" title="Permalink to this headline">¶</a></h4>
1969
+ <p>The total number of records returned to the client, which can be limited
1970
+ by the <code class="docutils literal"><span class="pre">TopN</span></code> header value.</p>
1971
+ </div>
1972
+ </div>
1973
+ <div class="section" id="id22">
1974
+ <h3>Errors<a class="headerlink" href="#id22" title="Permalink to this headline">¶</a></h3>
1975
+ <p>Any errors which occur during a <code class="docutils literal"><span class="pre">sow</span></code> command are returned in the
1976
+ <code class="docutils literal"><span class="pre">processed</span></code> acknowledgment message. The error is identified in the
1977
+ <code class="docutils literal"><span class="pre">Status</span></code> header field in the acknowledgment message, and the reason
1978
+ given in the <code class="docutils literal"><span class="pre">Reason</span></code> header field.</p>
1979
+ <div class="admonition caution">
1980
+ <p class="first admonition-title">Caution</p>
1981
+ <p class="last">The ordering of records returned by a SOW query is undefined.</p>
1982
+ </div>
1983
+ </div>
1984
+ </div>
1985
+ <div class="section" id="unsubscribe">
1986
+ <h2>unsubscribe<a class="headerlink" href="#unsubscribe" title="Permalink to this headline">¶</a></h2>
1987
+ <p>The <code class="docutils literal"><span class="pre">unsubscribe</span></code> command allows a client to notify AMPS that it no
1988
+ longer wishes to receive messages related to a previous subscription.</p>
1989
+ <p>There are two ways that a client can unsubscribe from an existing
1990
+ subscription:</p>
1991
+ <ol class="arabic simple">
1992
+ <li>Adding the <code class="docutils literal"><span class="pre">all</span></code> keyword to the <code class="docutils literal"><span class="pre">SubId</span></code> header field in the
1993
+ <code class="docutils literal"><span class="pre">unsubscribe</span></code> message will unsubscribe the client from all AMPS SOW
1994
+ topic subscriptions.</li>
1995
+ <li>With each <code class="docutils literal"><span class="pre">subscription</span></code> command issued, AMPS will return a
1996
+ <code class="docutils literal"><span class="pre">SubId</span></code> with the <code class="docutils literal"><span class="pre">processed</span></code> acknowledgment message. Issuing an
1997
+ <code class="docutils literal"><span class="pre">unsubscribe</span></code> command using the same <code class="docutils literal"><span class="pre">SubId</span></code> header field which
1998
+ was returned as part of the original <code class="docutils literal"><span class="pre">subscribe</span></code> command&#8217;s
1999
+ <code class="docutils literal"><span class="pre">processed</span></code> acknowledgment message will unsubscribe a client from a
2000
+ single subscription.</li>
2001
+ </ol>
2002
+ <div class="section" id="id23">
2003
+ <h3>Header Fields<a class="headerlink" href="#id23" title="Permalink to this headline">¶</a></h3>
2004
+ <table border="1" class="docutils" id="command-unsubscribe-headers">
2005
+ <colgroup>
2006
+ <col width="50%" />
2007
+ <col width="50%" />
2008
+ </colgroup>
2009
+ <thead valign="bottom">
2010
+ <tr class="row-odd"><th class="head"><strong>Field</strong></th>
2011
+ <th class="head"><strong>Description</strong></th>
2012
+ </tr>
2013
+ </thead>
2014
+ <tbody valign="top">
2015
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">Command</span></code></td>
2016
+ <td>Command to be executed. Value: <code class="docutils literal"><span class="pre">unsubscribe</span></code>.</td>
2017
+ </tr>
2018
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">SubId</span></code></td>
2019
+ <td><p class="first">Subscription ID entered in AMPS by the client
2020
+ when the original <code class="docutils literal"><span class="pre">subscription</span></code> was placed.
2021
+ AMPS accepts a single subscription ID or a
2022
+ comma-delimited list of subscription ID. The
2023
+ keyword <code class="docutils literal"><span class="pre">all</span></code> can also be used to unsubscribe
2024
+ from all current subscriptions for the client.
2025
+ When both <code class="docutils literal"><span class="pre">SubId</span></code> and <code class="docutils literal"><span class="pre">QueryId</span></code> are
2026
+ provided, AMPS removes all matching
2027
+ subscriptions and SOW queries.</p>
2028
+ <p class="last">This command requires at least one of the
2029
+ <code class="docutils literal"><span class="pre">SubId</span></code> or <code class="docutils literal"><span class="pre">QueryIdY</span></code> fields to be set.</p>
2030
+ </td>
2031
+ </tr>
2032
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">QueryId</span></code></td>
2033
+ <td><p class="first">To cancel an in-progress SOW query, the
2034
+ unsubscribe command accepts the Query ID entered
2035
+ in AMPS by the client when the original <code class="docutils literal"><span class="pre">sow</span></code>
2036
+ command was placed. AMPS accepts a single query
2037
+ ID or a comma-delimited list of query IDs. When
2038
+ both <code class="docutils literal"><span class="pre">SubId</span></code> and <code class="docutils literal"><span class="pre">QueryId</span></code> are provided,
2039
+ AMPS removes all matching subscriptions and SOW
2040
+ queries.</p>
2041
+ <p class="last">This command requires at least one of the
2042
+ <code class="docutils literal"><span class="pre">SubId</span></code> or <code class="docutils literal"><span class="pre">QueryId</span></code> fields to be set.</p>
2043
+ </td>
2044
+ </tr>
2045
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">AckType</span></code></td>
2046
+ <td>Acknowledgment type for the given command. Value
2047
+ is a comma separated list of one or more of the
2048
+ following: <code class="docutils literal"><span class="pre">none</span></code>, <code class="docutils literal"><span class="pre">received</span></code> or
2049
+ <code class="docutils literal"><span class="pre">persisted</span></code>.</td>
2050
+ </tr>
2051
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">CommandId</span></code></td>
2052
+ <td>If specified within an AMPS command requesting
2053
+ an acknowledgment message, all requested
2054
+ acknowledgment messages will contain the
2055
+ <code class="docutils literal"><span class="pre">CommandId</span></code> in the <code class="docutils literal"><span class="pre">ack</span></code> response header.</td>
2056
+ </tr>
2057
+ </tbody>
2058
+ </table>
2059
+ <p><em>Header fields supported by unsubscribe</em></p>
2060
+ </div>
2061
+ <div class="section" id="id24">
2062
+ <h3>Returns<a class="headerlink" href="#id24" title="Permalink to this headline">¶</a></h3>
2063
+ <p>The <code class="docutils literal"><span class="pre">unsubscribe</span></code> command supports the <code class="docutils literal"><span class="pre">received</span></code> and <code class="docutils literal"><span class="pre">processed</span></code>
2064
+ acknowledgment message types, as described in the
2065
+ following table.</p>
2066
+ <table border="1" class="docutils" id="command-unsubscribe-acks">
2067
+ <colgroup>
2068
+ <col width="50%" />
2069
+ <col width="50%" />
2070
+ </colgroup>
2071
+ <thead valign="bottom">
2072
+ <tr class="row-odd"><th class="head"><strong>Acknowledgment</strong></th>
2073
+ <th class="head"><strong>Description</strong></th>
2074
+ </tr>
2075
+ </thead>
2076
+ <tbody valign="top">
2077
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">none</span></code></td>
2078
+ <td>No acknowledgment message is returned. This is
2079
+ the default behavior.</td>
2080
+ </tr>
2081
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">completed</span></code></td>
2082
+ <td>Not supported at this time.</td>
2083
+ </tr>
2084
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">processed</span></code></td>
2085
+ <td>AMPS has processed the <code class="docutils literal"><span class="pre">unsubscribe</span></code>
2086
+ message(s).</td>
2087
+ </tr>
2088
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">persisted</span></code></td>
2089
+ <td>Not supported at this time.</td>
2090
+ </tr>
2091
+ <tr class="row-even"><td><code class="docutils literal"><span class="pre">received</span></code></td>
2092
+ <td>The <code class="docutils literal"><span class="pre">unsubscribe</span></code> message has been received.</td>
2093
+ </tr>
2094
+ <tr class="row-odd"><td><code class="docutils literal"><span class="pre">stats</span></code></td>
2095
+ <td>Not supported at this time.</td>
2096
+ </tr>
2097
+ </tbody>
2098
+ </table>
2099
+ <p><em>Acknowledgment messages supported by unsubscribe</em></p>
2100
+ </div>
2101
+ </div>
2102
+ </div>
2103
+
2104
+
2105
+ </div>
2106
+ </div>
2107
+ </div>
2108
+ <div class="clearer"></div>
2109
+ </div>
2110
+ <div class="footer">
2111
+ &copy;2022, 60East Technologies, Inc..
2112
+
2113
+ |
2114
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.5.3</a>
2115
+ &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
2116
+
2117
+ </div>
2118
+
2119
+
2120
+
2121
+
2122
+ </body>
2123
+ </html>