Fixed bug #794: Excessive memory when searching the LoC only.

[pazpar2-moved-to-github.git] / PROTOCOL

diff --git a/PROTOCOL b/PROTOCOL
index 272d9c6..4ddfd03 100644 (file)
--- a/PROTOCOL
+++ b/PROTOCOL
@@ -66,6 +66,7 @@ search.pz2?session=2044502273&command=stat
 Output:
 
 <stat>
+  <activeclients>3</activeclients>
   <hits>7</hits>                   -- Total hitcount
   <records>7</records>             -- Total number of records fetched
   <clients>1</clients>             -- Total number of associated clients
@@ -141,7 +142,7 @@ Output:
       <name>Donald Knuth</name>
       <frequency>10</frequency>
     </term>
-    <term>
+      <term>
       <name>Robert Pirsig</name>
       <frequency>2</frequency>
     </term>
@@ -153,3 +154,15 @@ Output:
     </term>
   </list>
 </termlist>
+
+For the special termlist name "xtargets", results are returned about the targets
+which have returned the most hits. The 'term' subtree has additional elements,
+specifically a state and diagnostic field (in the example below, a target ID is
+returned in place of 'name'. This may or may not change later.
+
+<term>
+  <name>library2.mcmaster.ca</name>
+  <frequency>11734</frequency>
+  <state>Client_Idle</state>
+  <diagnostic>0</diagnostic>
+</term>