X-Git-Url: http://jsfdemo.indexdata.com/?a=blobdiff_plain;f=doc%2Ffrontend.xml;h=391ca9dbb5b49a0bed07d96899c9bf480cd43f73;hb=f03238c89d03779b3d5731ffdcce0bd7c3e099bc;hp=03ee19aed22363c793fe55620ce9f42d857cdf51;hpb=3227202c561b3189378cba8318c7610aeae1421a;p=yaz-moved-to-github.git diff --git a/doc/frontend.xml b/doc/frontend.xml index 03ee19a..391ca9d 100644 --- a/doc/frontend.xml +++ b/doc/frontend.xml @@ -1,10 +1,10 @@ - + Making an IR Server for Your Database Introduction If you aren't into documentation, a good way to learn how the - backend interface works is to look at the backend.h + back end interface works is to look at the backend.h file. Then, look at the small dummy-server in ztest/ztest.c. Finally, you can have a look at the seshigh.c file, which is where most of the @@ -34,11 +34,11 @@ The backend interface was designed in anticipation of a specific integration task, while still attempting to achieve some degree of - generality. We realise fully that there are points where the + generality. We realize fully that there are points where the interface can be improved significantly. If you have specific functions or parameters that you think could be useful, send us a mail (or better, sign on to the mailing list referred to in the - toplevel README file). We will try to fit good suggestions into future + top-level README file). We will try to fit good suggestions into future releases, to the extent that it can be done without requiring too many structural changes in existing applications. @@ -111,7 +111,7 @@ will include other files from the include/yaz directory, so you'll probably want to use the -I option of your compiler to tell it where to find the files. When you run - make in the toplevel &yaz; directory, + make in the top-level &yaz; directory, everything you need to create your server is put the lib/libyaz.a library. @@ -269,7 +269,7 @@ statserv_options_block *statserv_getcontrol(void); void (*bend_stop)(struct statserv_options_block *p) - Pointer to function which is called whenver the server + Pointer to function which is called whenever the server has stopped listening for incoming connections. This function pointer has a default value of NULL in which case it isn't called. When the server operates as an NT service this handler is called @@ -412,7 +412,7 @@ typedef struct bend_initresult Search and retrieve We now describe the handlers that are required to support search - - and retrieve. You must support two functions - one for seearch - and one + and retrieve. You must support two functions - one for search - and one for fetch (retrieval of one record). If desirable you can provide a third handler which is called when a present request is received which allows you to optimize retrieval of multiple-records. @@ -604,7 +604,7 @@ typedef struct { Delete - For backends that supports delete of a result set only one handler + For back-ends that supports delete of a result set only one handler must be defined.