Added routines

	Net::Z3950::SimpleServer::ScanSuccess
	Net::Z3950::SimpleServer::ScanPartial

and a bit of documentation.

diff --git a/SimpleServer.c b/SimpleServer.c
index 6d6629e..2f7541a 100644 (file)
--- a/SimpleServer.c
+++ b/SimpleServer.c
@@ -34,7 +34,15 @@
  */
 
 /*$Log: SimpleServer.c,v $
  */
 
 /*$Log: SimpleServer.c,v $

-/*Revision 1.11  2001-08-24 14:00:20  sondberg
+/*Revision 1.12  2001-08-29 11:48:35  sondberg
+/*Added routines
+/*
+/*     Net::Z3950::SimpleServer::ScanSuccess
+/*     Net::Z3950::SimpleServer::ScanPartial
+/*
+/*and a bit of documentation.
+/*
+/*Revision 1.9  2001/08/24 14:00:20  sondberg

 /*Added support for scan.
 /*
 /*Revision 1.8  2001/05/21 11:07:02  sondberg
 /*Added support for scan.
 /*
 /*Revision 1.8  2001/05/21 11:07:02  sondberg

@@ -1040,7 +1048,7 @@ void bend_close(void *handle)
 }
 
 
 }
 
 

-#line 1041 "SimpleServer.c"
+#line 1044 "SimpleServer.c"

 XS(XS_Net__Z3950__SimpleServer_set_init_handler)
 {
     dXSARGS;
 XS(XS_Net__Z3950__SimpleServer_set_init_handler)
 {
     dXSARGS;

@@ -1048,9 +1056,9 @@ XS(XS_Net__Z3950__SimpleServer_set_init_handler)
        croak("Usage: Net::Z3950::SimpleServer::set_init_handler(arg)");
     {
        SV *    arg = ST(0);
        croak("Usage: Net::Z3950::SimpleServer::set_init_handler(arg)");
     {
        SV *    arg = ST(0);

-#line 1037 "SimpleServer.xs"
+#line 1040 "SimpleServer.xs"

                init_ref = newSVsv(arg);
                init_ref = newSVsv(arg);

-#line 1051 "SimpleServer.c"
+#line 1054 "SimpleServer.c"

     }
     XSRETURN_EMPTY;
 }
     }
     XSRETURN_EMPTY;
 }

@@ -1062,9 +1070,9 @@ XS(XS_Net__Z3950__SimpleServer_set_close_handler)
        croak("Usage: Net::Z3950::SimpleServer::set_close_handler(arg)");
     {
        SV *    arg = ST(0);
        croak("Usage: Net::Z3950::SimpleServer::set_close_handler(arg)");
     {
        SV *    arg = ST(0);

-#line 1044 "SimpleServer.xs"
+#line 1047 "SimpleServer.xs"

                close_ref = newSVsv(arg);
                close_ref = newSVsv(arg);

-#line 1065 "SimpleServer.c"
+#line 1068 "SimpleServer.c"

     }
     XSRETURN_EMPTY;
 }
     }
     XSRETURN_EMPTY;
 }

@@ -1076,9 +1084,9 @@ XS(XS_Net__Z3950__SimpleServer_set_sort_handler)
        croak("Usage: Net::Z3950::SimpleServer::set_sort_handler(arg)");
     {
        SV *    arg = ST(0);
        croak("Usage: Net::Z3950::SimpleServer::set_sort_handler(arg)");
     {
        SV *    arg = ST(0);

-#line 1051 "SimpleServer.xs"
+#line 1054 "SimpleServer.xs"

                sort_ref = newSVsv(arg);
                sort_ref = newSVsv(arg);

-#line 1079 "SimpleServer.c"
+#line 1082 "SimpleServer.c"

     }
     XSRETURN_EMPTY;
 }
     }
     XSRETURN_EMPTY;
 }

@@ -1090,9 +1098,9 @@ XS(XS_Net__Z3950__SimpleServer_set_search_handler)
        croak("Usage: Net::Z3950::SimpleServer::set_search_handler(arg)");
     {
        SV *    arg = ST(0);
        croak("Usage: Net::Z3950::SimpleServer::set_search_handler(arg)");
     {
        SV *    arg = ST(0);

-#line 1057 "SimpleServer.xs"
+#line 1060 "SimpleServer.xs"

                search_ref = newSVsv(arg);
                search_ref = newSVsv(arg);

-#line 1093 "SimpleServer.c"
+#line 1096 "SimpleServer.c"

     }
     XSRETURN_EMPTY;
 }
     }
     XSRETURN_EMPTY;
 }

@@ -1104,9 +1112,9 @@ XS(XS_Net__Z3950__SimpleServer_set_fetch_handler)
        croak("Usage: Net::Z3950::SimpleServer::set_fetch_handler(arg)");
     {
        SV *    arg = ST(0);
        croak("Usage: Net::Z3950::SimpleServer::set_fetch_handler(arg)");
     {
        SV *    arg = ST(0);

-#line 1064 "SimpleServer.xs"
+#line 1067 "SimpleServer.xs"

                fetch_ref = newSVsv(arg);
                fetch_ref = newSVsv(arg);

-#line 1107 "SimpleServer.c"
+#line 1110 "SimpleServer.c"

     }
     XSRETURN_EMPTY;
 }
     }
     XSRETURN_EMPTY;
 }

@@ -1118,9 +1126,9 @@ XS(XS_Net__Z3950__SimpleServer_set_present_handler)
        croak("Usage: Net::Z3950::SimpleServer::set_present_handler(arg)");
     {
        SV *    arg = ST(0);
        croak("Usage: Net::Z3950::SimpleServer::set_present_handler(arg)");
     {
        SV *    arg = ST(0);

-#line 1071 "SimpleServer.xs"
+#line 1074 "SimpleServer.xs"

                present_ref = newSVsv(arg);
                present_ref = newSVsv(arg);

-#line 1121 "SimpleServer.c"
+#line 1124 "SimpleServer.c"

     }
     XSRETURN_EMPTY;
 }
     }
     XSRETURN_EMPTY;
 }

@@ -1132,9 +1140,9 @@ XS(XS_Net__Z3950__SimpleServer_set_esrequest_handler)
        croak("Usage: Net::Z3950::SimpleServer::set_esrequest_handler(arg)");
     {
        SV *    arg = ST(0);
        croak("Usage: Net::Z3950::SimpleServer::set_esrequest_handler(arg)");
     {
        SV *    arg = ST(0);

-#line 1078 "SimpleServer.xs"
+#line 1081 "SimpleServer.xs"

                esrequest_ref = newSVsv(arg);
                esrequest_ref = newSVsv(arg);

-#line 1135 "SimpleServer.c"
+#line 1138 "SimpleServer.c"

     }
     XSRETURN_EMPTY;
 }
     }
     XSRETURN_EMPTY;
 }

@@ -1146,9 +1154,9 @@ XS(XS_Net__Z3950__SimpleServer_set_delete_handler)
        croak("Usage: Net::Z3950::SimpleServer::set_delete_handler(arg)");
     {
        SV *    arg = ST(0);
        croak("Usage: Net::Z3950::SimpleServer::set_delete_handler(arg)");
     {
        SV *    arg = ST(0);

-#line 1085 "SimpleServer.xs"
+#line 1088 "SimpleServer.xs"

                delete_ref = newSVsv(arg);
                delete_ref = newSVsv(arg);

-#line 1149 "SimpleServer.c"
+#line 1152 "SimpleServer.c"

     }
     XSRETURN_EMPTY;
 }
     }
     XSRETURN_EMPTY;
 }

@@ -1160,9 +1168,9 @@ XS(XS_Net__Z3950__SimpleServer_set_scan_handler)
        croak("Usage: Net::Z3950::SimpleServer::set_scan_handler(arg)");
     {
        SV *    arg = ST(0);
        croak("Usage: Net::Z3950::SimpleServer::set_scan_handler(arg)");
     {
        SV *    arg = ST(0);

-#line 1092 "SimpleServer.xs"
+#line 1095 "SimpleServer.xs"

                scan_ref = newSVsv(arg);
                scan_ref = newSVsv(arg);

-#line 1163 "SimpleServer.c"
+#line 1166 "SimpleServer.c"

     }
     XSRETURN_EMPTY;
 }
     }
     XSRETURN_EMPTY;
 }

@@ -1171,15 +1179,15 @@ XS(XS_Net__Z3950__SimpleServer_start_server)
 {
     dXSARGS;
     {
 {
     dXSARGS;
     {

-#line 1098 "SimpleServer.xs"
+#line 1101 "SimpleServer.xs"

                char **argv;
                char **argv_buf;
                char *ptr;
                int i;
                STRLEN len;
                char **argv;
                char **argv_buf;
                char *ptr;
                int i;
                STRLEN len;

-#line 1178 "SimpleServer.c"
+#line 1181 "SimpleServer.c"

        int     RETVAL;
        int     RETVAL;

-#line 1104 "SimpleServer.xs"
+#line 1107 "SimpleServer.xs"

                argv_buf = (char **)xmalloc((items + 1) * sizeof(char *));
                argv = argv_buf;
                for (i = 0; i < items; i++)
                argv_buf = (char **)xmalloc((items + 1) * sizeof(char *));
                argv = argv_buf;
                for (i = 0; i < items; i++)

@@ -1191,7 +1199,39 @@ XS(XS_Net__Z3950__SimpleServer_start_server)
                *argv_buf = NULL;
 
                RETVAL = statserv_main(items, argv, bend_init, bend_close);
                *argv_buf = NULL;
 
                RETVAL = statserv_main(items, argv, bend_init, bend_close);

-#line 1192 "SimpleServer.c"
+#line 1195 "SimpleServer.c"
+       ST(0) = sv_newmortal();
+       sv_setiv(ST(0), (IV)RETVAL);
+    }
+    XSRETURN(1);
+}
+
+XS(XS_Net__Z3950__SimpleServer_ScanSuccess)
+{
+    dXSARGS;
+    if (items != 0)
+       croak("Usage: Net::Z3950::SimpleServer::ScanSuccess()");
+    {
+       int     RETVAL;
+#line 1125 "SimpleServer.xs"
+               RETVAL = BEND_SCAN_SUCCESS;
+#line 1211 "SimpleServer.c"
+       ST(0) = sv_newmortal();
+       sv_setiv(ST(0), (IV)RETVAL);
+    }
+    XSRETURN(1);
+}
+
+XS(XS_Net__Z3950__SimpleServer_ScanPartial)
+{
+    dXSARGS;
+    if (items != 0)
+       croak("Usage: Net::Z3950::SimpleServer::ScanPartial()");
+    {
+       int     RETVAL;
+#line 1132 "SimpleServer.xs"
+               RETVAL = BEND_SCAN_PARTIAL;
+#line 1227 "SimpleServer.c"

        ST(0) = sv_newmortal();
        sv_setiv(ST(0), (IV)RETVAL);
     }
        ST(0) = sv_newmortal();
        sv_setiv(ST(0), (IV)RETVAL);
     }

@@ -1218,6 +1258,8 @@ XS(boot_Net__Z3950__SimpleServer)
         newXS("Net::Z3950::SimpleServer::set_delete_handler", XS_Net__Z3950__SimpleServer_set_delete_handler, file);
         newXS("Net::Z3950::SimpleServer::set_scan_handler", XS_Net__Z3950__SimpleServer_set_scan_handler, file);
         newXS("Net::Z3950::SimpleServer::start_server", XS_Net__Z3950__SimpleServer_start_server, file);
         newXS("Net::Z3950::SimpleServer::set_delete_handler", XS_Net__Z3950__SimpleServer_set_delete_handler, file);
         newXS("Net::Z3950::SimpleServer::set_scan_handler", XS_Net__Z3950__SimpleServer_set_scan_handler, file);
         newXS("Net::Z3950::SimpleServer::start_server", XS_Net__Z3950__SimpleServer_start_server, file);

+        newXS("Net::Z3950::SimpleServer::ScanSuccess", XS_Net__Z3950__SimpleServer_ScanSuccess, file);
+        newXS("Net::Z3950::SimpleServer::ScanPartial", XS_Net__Z3950__SimpleServer_ScanPartial, file);

     XSRETURN_YES;
 }
 
     XSRETURN_YES;
 }
 

diff --git a/SimpleServer.pm b/SimpleServer.pm
index cc6c7d0..3dc3d2c 100644 (file)
--- a/SimpleServer.pm
+++ b/SimpleServer.pm
@@ -26,7 +26,15 @@
 ##
 
 ## $Log: SimpleServer.pm,v $
 ##
 
 ## $Log: SimpleServer.pm,v $

-## Revision 1.8  2001-08-29 10:29:51  sondberg
+## Revision 1.9  2001-08-29 11:48:36  sondberg
+## Added routines
+##
+##     Net::Z3950::SimpleServer::ScanSuccess
+##     Net::Z3950::SimpleServer::ScanPartial
+##
+## and a bit of documentation.
+##
+## Revision 1.8  2001/08/29 10:29:51  sondberg

 ## Added some documentation of scan.
 ##
 ## Revision 1.7  2001/08/24 14:00:20  sondberg
 ## Added some documentation of scan.
 ##
 ## Revision 1.7  2001/08/24 14:00:20  sondberg

@@ -424,7 +432,7 @@ an index of a book, you always find something! The parameters exchanged are
                ERR_CODE        => 0,           ## Error code
                ERR_STR         => '',          ## Diagnostic message
                NUMBER          => zz,          ## Number of returned terms
                ERR_CODE        => 0,           ## Error code
                ERR_STR         => '',          ## Diagnostic message
                NUMBER          => zz,          ## Number of returned terms

-               STATUS          => ScanSuccess, ## ScanSuccess/ScanFailure
+               STATUS          => $status,     ## ScanSuccess/ScanFailure

                ENTRIES         => $entries     ## Referenced list of terms
        };
 
                ENTRIES         => $entries     ## Referenced list of terms
        };
 

@@ -445,7 +453,14 @@ should point at a data structure of this kind,
 
                                ...
        ];
 
                                ...
        ];

-                       
+
+The $status flag should be assigned one of two values:
+
+  Net::Z3950::SimpleServer::ScanSuccess  On success (default)
+  Net::Z3950::SimpleServer::ScanPartial  Less terms returned than requested
+
+The STEP member contains the requested number of entries in the term-list
+between two adjacent entries in the response.

 
 =head2 Close handler
 
 
 =head2 Close handler
 

diff --git a/SimpleServer.xs b/SimpleServer.xs
index cbf2b5b..cc1d461 100644 (file)
--- a/SimpleServer.xs
+++ b/SimpleServer.xs
@@ -25,7 +25,15 @@
  */
 
 /*$Log: SimpleServer.xs,v $
  */
 
 /*$Log: SimpleServer.xs,v $

-/*Revision 1.9  2001-08-24 14:00:20  sondberg
+/*Revision 1.10  2001-08-29 11:48:36  sondberg
+/*Added routines
+/*
+/*     Net::Z3950::SimpleServer::ScanSuccess
+/*     Net::Z3950::SimpleServer::ScanPartial
+/*
+/*and a bit of documentation.
+/*
+/*Revision 1.9  2001/08/24 14:00:20  sondberg

 /*Added support for scan.
 /*
 /*Revision 1.8  2001/05/21 11:07:02  sondberg
 /*Added support for scan.
 /*
 /*Revision 1.8  2001/05/21 11:07:02  sondberg

@@ -1116,4 +1124,21 @@ start_server(...)
                
                RETVAL = statserv_main(items, argv, bend_init, bend_close);
        OUTPUT:
                
                RETVAL = statserv_main(items, argv, bend_init, bend_close);
        OUTPUT:

-               RETVAL 
+               RETVAL
+
+
+int
+ScanSuccess()
+       CODE:
+               RETVAL = BEND_SCAN_SUCCESS;
+       OUTPUT:
+               RETVAL
+
+int
+ScanPartial()
+       CODE:
+               RETVAL = BEND_SCAN_PARTIAL;
+       OUTPUT:
+               RETVAL
+
+ 

diff --git a/ztest.pl b/ztest.pl
index f0a224e..0f76d5f 100755 (executable)
--- a/ztest.pl
+++ b/ztest.pl
@@ -55,6 +55,7 @@ sub my_scan_handler {
 
        $args->{NUMBER} = 10;
        $args->{ENTRIES} = $entries;
 
        $args->{NUMBER} = 10;
        $args->{ENTRIES} = $entries;

+       $args->{STATUS} = Net::Z3950::SimpleServer::ScanPartial;

        print "Welcome to scan....\n";
        print "You scanned for term '$term'\n";
 }
        print "Welcome to scan....\n";
        print "You scanned for term '$term'\n";
 }

@@ -128,7 +129,15 @@ $handler->launch_server("ztest.pl", @ARGV);
 
 
 ## $Log: ztest.pl,v $
 
 
 ## $Log: ztest.pl,v $

-## Revision 1.8  2001-08-24 14:00:20  sondberg
+## Revision 1.9  2001-08-29 11:48:36  sondberg
+## Added routines
+##
+##     Net::Z3950::SimpleServer::ScanSuccess
+##     Net::Z3950::SimpleServer::ScanPartial
+##
+## and a bit of documentation.
+##
+## Revision 1.8  2001/08/24 14:00:20  sondberg

 ## Added support for scan.
 ##
 ## Revision 1.7  2001/03/13 14:20:21  sondberg
 ## Added support for scan.
 ##
 ## Revision 1.7  2001/03/13 14:20:21  sondberg