X-Git-Url: http://jsfdemo.indexdata.com/?a=blobdiff_plain;f=PROTOCOL;h=35d1a00340c9eec07963a59eb09c0d6bf64ed6e5;hb=d3daf2613e7577626bc84c54b4b70f74aff7f8e7;hp=2f9c22f9558d2c66fb91d4b88640ff7d9a691311;hpb=5ca759f28d681f9c8cf954655571cc9963c27b04;p=pazpar2-moved-to-github.git

diff --git a/PROTOCOL b/PROTOCOL
index 2f9c22f..35d1a00 100644
--- a/PROTOCOL
+++ b/PROTOCOL
@@ -1,7 +1,8 @@
 
 Webservice requests are any that refer to filename "search.pz2". Arguments
 are GET-style parameters. Argument 'command' is required and specifies
-command.
+command. Any request not recognized as a webservice request as described,
+are forwarded to the HTTP server specified in option -p.
 
 Commands:
 
@@ -18,6 +19,23 @@ Response example:
   <session>2044502273</session>
 </init>
 
+ping
+
+Keeps a session alive. An idle session will time out after one minute. The
+ping command can be used to keep the session alive absent other activity. It
+is suggested that any browser client have a simple alarm handler which
+sends a ping every 50 seconds or so once a session has been initialized.
+
+Example:
+
+search.pz?command=ping&session=2044502273
+
+Response example:
+
+<ping>
+  <status>OK</status>
+</ping>
+
 search
 
 Launches a search, parameters:
@@ -70,6 +88,11 @@ parameters:
 session
 start      -- 0-indexed!!
 num        -- default=20
+block      -- 0 or 1
+
+If block is set, the command will hang until there are records ready
+to display. Use this to show first records rapidly without requiring rapid
+polling.
 
 Example: