backend.h

Go to the documentation of this file.

/* This file is part of the YAZ toolkit.
 * Copyright (C) Index Data.
 * All rights reserved.
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of Index Data nor the names of its contributors
 *       may be used to endorse or promote products derived from this
 *       software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

 
#ifndef BACKEND_H
#define BACKEND_H
 
#include <yaz/yconfig.h>
#include <yaz/proto.h>
#include <yaz/srw.h>
#include <yaz/oid_db.h>
 
YAZ_BEGIN_CDECL
 
typedef struct association *bend_association;

typedef struct {
    char *setname;             
    int replace_set;           
    int num_bases;             
    char **basenames;          
    Z_ReferenceId *referenceId;
    Z_Query *query;            
    ODR stream;                
    ODR decode;                
    ODR print;                 
 
    bend_association association; 
    Odr_int hits;              
    int errcode;               
    char *errstring;           
    Z_OtherInformation *search_info; 
    char *srw_sortKeys;        
    char *srw_setname;         
    int *srw_setnameIdleTime;  
    int estimated_hit_count;   
    int partial_resultset;     
    Z_SRW_extra_arg *extra_args; 
    char *extra_response_data;   
    Z_OtherInformation *search_input; 
    Odr_int present_number;    
} bend_search_rr;

typedef struct {
    char *setname;             
    int start;                 
    int number;                
    Odr_oid *format;           
    Z_ReferenceId *referenceId;
    Z_RecordComposition *comp; 
    ODR stream;                
    ODR print;                 
    bend_association association; 
 
    int errcode;               
    char *errstring;           
} bend_present_rr;

typedef struct bend_fetch_rr {
    char *setname;             
    int number;                
    Z_ReferenceId *referenceId;
    Odr_oid *request_format;   
    Z_RecordComposition *comp; 
    ODR stream;                
    ODR print;                 
 
    char *basename;            
    int len;                   
    char *record;              
    int last_in_set;           
    Odr_oid *output_format;    
    int errcode;               
    char *errstring;           
    int surrogate_flag;        
    char *schema;              
} bend_fetch_rr;

struct scan_entry {
    char *term;         
    Odr_int occurrences;
    int errcode;        
    char *errstring;    
    char *display_term;
};
 
typedef enum {
    BEND_SCAN_SUCCESS,  
    BEND_SCAN_PARTIAL   
} bend_scan_status;

typedef struct bend_scan_rr {
    int num_bases;      
    char **basenames;   
    Odr_oid *attributeset; 
    Z_ReferenceId *referenceId; 
    Z_AttributesPlusTerm *term; 
    ODR stream;         
    ODR print;          
 
    int *step_size;     
    int term_position;  
    int num_entries;    
 
    /* scan term entries. The called handler does not have
       to allocate this. Size of entries is num_entries (see above) */
    struct scan_entry *entries;
    bend_scan_status status;
    int errcode;
    char *errstring;
    char *scanClause;   
    char *setname;      
    Z_SRW_extra_arg *extra_args; 
    char *extra_response_data;   
} bend_scan_rr;

typedef struct bend_update_rr {
    int num_bases;      
    char **basenames;   
    Z_ReferenceId *referenceId; 
    ODR stream;         
    ODR print;          
    char *operation;
    char *operation_status;
    char *record_id;
    Z_SRW_recordVersion *record_versions;
    int num_versions;
    char *record_packing;
    char *record_schema;
    char *record_data;
    char *extra_record_data;
    char *extra_request_data;
    char *extra_response_data;
    char *uri;
    char *message;
    char *details;
} bend_update_rr;

typedef struct bend_delete_rr {
    int function;
    int num_setnames;
    char **setnames;
    Z_ReferenceId *referenceId;
    int delete_status;    
    int *statuses;    
    ODR stream;
    ODR print;
} bend_delete_rr;

typedef struct bend_sort_rr
{
    int num_input_setnames;
    char **input_setnames;
    char *output_setname;
    Z_SortKeySpecList *sort_sequence;
    ODR stream;
    ODR print;
    Z_ReferenceId *referenceId;
 
    int sort_status;
    int errcode;
    char *errstring;
} bend_sort_rr;

typedef struct bend_esrequest_rr
{
    int ItemNo;
    Z_ExtendedServicesRequest *esr;
 
    ODR stream;                /* encoding stream */
    ODR decode;                /* decoding stream */
    ODR print;                 /* printing stream */
    Z_ReferenceId *referenceId;/* reference ID */
    bend_association association;
    int errcode;               /* 0==success, -1==accepted, >0 = failure */
    char *errstring;           /* system error string or NULL */
    Z_TaskPackage *taskPackage;
    Z_External *taskPackageExt;
} bend_esrequest_rr;

typedef struct bend_segment_rr {
    Z_Segment *segment;
    ODR stream;
    ODR decode;
    ODR print;
    bend_association association;
} bend_segment_rr;

typedef struct {
    ODR stream;
    ODR decode;
    ODR print;
    char *explain_buf;
    char *database;
    char *schema;
    void *server_node_ptr;
} bend_explain_rr;

typedef struct bend_initrequest
{
    Z_IdAuthentication *auth;
    ODR stream;
    ODR print;
    ODR decode;
    Z_ReferenceId *referenceId;
    char *peer_name;

    Z_CharSetandLanguageNegotiation *charneg_request;

    Z_External *charneg_response;

    char *query_charset;

    int records_in_same_charset;
 
    char *implementation_id;
    char *implementation_name;
    char *implementation_version;

    int (*bend_sort)(void *handle, bend_sort_rr *rr);
    int (*bend_search)(void *handle, bend_search_rr *rr);
    int (*bend_fetch)(void *handle, bend_fetch_rr *rr);
    int (*bend_present)(void *handle, bend_present_rr *rr);
    int (*bend_esrequest) (void *handle, bend_esrequest_rr *rr);
    int (*bend_delete)(void *handle, bend_delete_rr *rr);
    int (*bend_scan)(void *handle, bend_scan_rr *rr);
    int (*bend_segment)(void *handle, bend_segment_rr *rr);
    int (*bend_explain)(void *handle, bend_explain_rr *rr);
    int (*bend_srw_scan)(void *handle, bend_scan_rr *rr);
    int (*bend_srw_update)(void *handle, bend_update_rr *rr);

    int named_result_sets;
} bend_initrequest;

typedef struct bend_initresult
{
    int errcode;               /* 0==OK */
    char *errstring;           /* system error string or NULL */
    void *handle;              /* private handle to the backend module */
} bend_initresult;
 
#define BEND_NAME_MAX 1024

typedef struct statserv_options_block
{
    int dynamic;                  
    int threads;                  
    int one_shot;                 
    char apdufile[BEND_NAME_MAX]; 
    char logfile[BEND_NAME_MAX];  
    enum oid_proto default_proto; 
    int idle_timeout;             
    int maxrecordsize;            
    char configname[BEND_NAME_MAX]; 
    char setuid[BEND_NAME_MAX];   
    void (*bend_start)(struct statserv_options_block *p);
    void (*bend_stop)(struct statserv_options_block *p);
    int (*options_func)(int argc, char **argv);
    int (*check_ip)(void *cd, const char *addr, int len, int type);
    char daemon_name[BEND_NAME_MAX];
    int inetd;                    
 
    void *handle;                 
    bend_initresult *(*bend_init)(bend_initrequest *r);
    void (*bend_close)(void *handle);
#ifdef WIN32
    /* We only have these members for the windows version */
    /* They seemed a bit large to have them there in general */
    char service_name[BEND_NAME_MAX];
    char app_name[BEND_NAME_MAX];  
    char service_dependencies[BEND_NAME_MAX];
    char service_display_name[BEND_NAME_MAX];
#endif /* WIN32 */
    char pid_fname[BEND_NAME_MAX]; 
    int background;                
    char cert_fname[BEND_NAME_MAX];
    char xml_config[BEND_NAME_MAX];
    int keepalive;                 
} statserv_options_block;
 
YAZ_EXPORT int statserv_main(
    int argc, char **argv,
    bend_initresult *(*bend_init)(bend_initrequest *r),
    void (*bend_close)(void *handle));
 
YAZ_EXPORT statserv_options_block *statserv_getcontrol(void);
YAZ_EXPORT void statserv_setcontrol(statserv_options_block *block);
YAZ_EXPORT int check_ip_tcpd(void *cd, const char *addr, int len, int type);
 
YAZ_EXPORT int bend_assoc_is_alive(bend_association assoc);
 
YAZ_END_CDECL
 
#endif
/*
 * Local variables:
 * c-basic-offset: 4
 * c-file-style: "Stroustrup"
 * indent-tabs-mode: nil
 * End:
 * vim: shiftwidth=4 tabstop=8 expandtab
 */