X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Ffrontend.xml;h=14a564bf954cfa7e9d3623b31554125f7bc15554;hb=23511a86ab565d5a4ce3c8f5924a49e9d310ba98;hp=2350af3ef892eda070163d754a273cf5543e165e;hpb=21f7c16c6b1b694405dbc1760d3d6cb3caac38f6;p=yaz-moved-to-github.git diff --git a/doc/frontend.xml b/doc/frontend.xml index 2350af3..14a564b 100644 --- a/doc/frontend.xml +++ b/doc/frontend.xml @@ -1,6 +1,6 @@ - + Generic server - Introduction + Introduction If you aren't into documentation, a good way to learn how the @@ -167,7 +167,7 @@ int statserv_main(int argc, char **argv, -statserv_options_block *statserv_getcontrol(void); + statserv_options_block *statserv_getcontrol(void); @@ -200,18 +200,12 @@ statserv_options_block *statserv_getcontrol(void); - int loglevel - Set this by ORing the constants defined in - include/yaz/yaz-log.h. - - - - char logfile[ODR_MAXNAME+1] + char logfile[ODR_MAXNAME+1] File for diagnostic output ("": stderr). - char apdufile[ODR_MAXNAME+1] + char apdufile[ODR_MAXNAME+1] Name of file for logging incoming and outgoing APDUs ("": don't log APDUs, "-": @@ -219,7 +213,7 @@ statserv_options_block *statserv_getcontrol(void); - char default_listen[1024] + char default_listen[1024] Same form as the command-line specification of listener address. "": no default listener address. Default is to listen at "tcp:@:9999". You can only @@ -250,12 +244,12 @@ statserv_options_block *statserv_getcontrol(void); - char configname[ODR_MAXNAME+1] + char configname[ODR_MAXNAME+1] Passed to the backend when a new connection is received. - char setuid[ODR_MAXNAME+1] + char setuid[ODR_MAXNAME+1] Set user id to the user specified, after binding the listener addresses. @@ -321,7 +315,7 @@ void statserv_setcontrol(statserv_options_block *block); functions representing the services that you wish to implement. - Init + Init bend_initresult (*bend_init)(bend_initrequest *r); @@ -435,7 +429,7 @@ typedef struct bend_initresult - Search and retrieve + Search and Retrieve We now describe the handlers that are required to support search - and retrieve. You must support two functions - one for search - and one @@ -509,7 +503,7 @@ typedef struct { structure (note that CQL is now part of Z39.50 via an external). To support CQL in existing implementations that only do Type-1, we refer to the CQL-to-PQF tool described - here. + here. @@ -656,7 +650,7 @@ typedef struct { - Delete + Delete For back-ends that supports delete of a result set only one handler @@ -690,7 +684,7 @@ typedef struct bend_delete_rr { - scan + Scan For servers that wish to offer the scan service one handler @@ -768,7 +762,7 @@ typedef struct bend_scan_rr { - hostname | IP-number [: portnumber] + hostname | IP-number [: portnumber] @@ -785,7 +779,7 @@ typedef struct bend_scan_rr { which causes the server to listen on any local interface. - Running the GFS on Unix + Running the GFS on Unix Assuming the server application appname is started as root, the following will make it listen on port 210. @@ -799,7 +793,7 @@ typedef struct bend_scan_rr { The server will accept Z39.50 requests and offer SRU service on port 210. - Setting up Apache as SRU Frontend + Setting up Apache as SRU Frontend If you use Apache as your public web server and want to offer HTTP port 80 @@ -822,7 +816,8 @@ typedef struct bend_scan_rr { The above for the Apache 1.3 series. - Running a server with local access only + + Running a server with local access only Servers that is only being accessed from the local host should listen on UNIX file socket rather than a Internet socket. To listen on