Added a couple of lines of documentation.
authorAnders S. Mortensen <sondberg@indexdata.dk>
Tue, 5 Mar 2002 20:49:56 +0000 (20:49 +0000)
committerAnders S. Mortensen <sondberg@indexdata.dk>
Tue, 5 Mar 2002 20:49:56 +0000 (20:49 +0000)
SimpleServer.pm

index 2893c50..ec8949b 100644 (file)
 ##
 
 ## $Log: SimpleServer.pm,v $
-## Revision 1.10  2002-02-28 11:21:57  mike
+## Revision 1.11  2002-03-05 20:49:56  sondberg
+## Added a couple of lines of documentation.
+##
+## Revision 1.10  2002/02/28 11:21:57  mike
 ## Add RPN structure to search-handler argument hash.
 ##
 ## Revision 1.9  2001/08/29 11:48:36  sondberg
@@ -296,6 +299,8 @@ mous hash. The structure is the following:
             DATABASES =>  ["xxx"], ## Reference to a list of data-
                                    ## bases to search
             QUERY     =>  "query", ## The query expression
+            RPN       =>  $obj,    ## Blessed reference int the package
+                                   ## Net::Z3950::APDU::Query
 
                                    ## Response parameters:
 
@@ -340,6 +345,11 @@ it is perfectly legal to not accept boolean operators, but you SHOULD
 try to return good error codes if you run into something you can't or
 won't support.
 
+The RPN member is a blessed reference into the package Net::Z3950::APDU::Query.
+By means of an augmented type of coding, you can easily construct a
+parser of the incoming RPN. Take a look at samples/render-search.pl for
+a sample implementation of such an augmented parser technique. 
+
 =head2 Present handler
 
 The presence of a present handler in a SimpleServer front-end is optional.
@@ -495,7 +505,7 @@ or something similar, this is the place to do it.
 =head1 AUTHORS
 
 Anders Sønderberg (sondberg@indexdata.dk) and Sebastian Hammer
-(quinn@indexdata.dk).
+(quinn@indexdata.dk). Substantial contributions made by Mike Taylor (mike@tecc.co.uk).
 
 =head1 SEE ALSO