Refactor rpn2perl() to clarify structure.

[simpleserver-moved-to-github.git] / SimpleServer.pm

diff --git a/SimpleServer.pm b/SimpleServer.pm
index e3ee48e..f6a4c39 100644 (file)
--- a/SimpleServer.pm
+++ b/SimpleServer.pm
@@ -25,7 +25,7 @@
 ##
 ##
 
 ##
 ##
 

-## $Id: SimpleServer.pm,v 1.33 2007-08-08 12:09:19 mike Exp $
+## $Id: SimpleServer.pm,v 1.35 2007-08-15 13:21:22 mike Exp $

 
 package Net::Z3950::SimpleServer;
 
 
 package Net::Z3950::SimpleServer;
 

@@ -596,8 +596,10 @@ an index of a book, you always find something! The parameters exchanged are
   $args = {
                                                ## Client request
 
   $args = {
                                                ## Client request
 

-               GHANDLE         => $obj         ## Global handler specified at creation
-               HANDLE          => $ref         ## Reference to data structure
+               GHANDLE         => $obj,        ## Global handler specified at creation
+               HANDLE          => $ref,        ## Reference to data structure
+               DATABASES       => ["xxx"],     ## Reference to a list of data-
+                                               ## bases to search

                TERM            => 'start',     ## The start term
                NUMBER          => xx,          ## Number of requested terms
                POS             => yy,          ## Position of starting point
                TERM            => 'start',     ## The start term
                NUMBER          => xx,          ## Number of requested terms
                POS             => yy,          ## Position of starting point

@@ -631,10 +633,11 @@ should point at a data structure of this kind,
                                ...
        ];
 
                                ...
        ];
 

-The $status flag should be assigned one of two values:
+The $status flag is only meaningful after a successful scan, and
+should be assigned one of two values:

 
 

-  Net::Z3950::SimpleServer::ScanSuccess  On success (default)
-  Net::Z3950::SimpleServer::ScanPartial  Less terms returned than requested
+  Net::Z3950::SimpleServer::ScanSuccess  Full success (default)
+  Net::Z3950::SimpleServer::ScanPartial  Fewer terms returned than requested

 
 The STEP member contains the requested number of entries in the term-list
 between two adjacent entries in the response.
 
 The STEP member contains the requested number of entries in the term-list
 between two adjacent entries in the response.