src/client.h

   1 /* This file is part of Pazpar2.
   2    Copyright (C) 2006-2008 Index Data
   3
   4 Pazpar2 is free software; you can redistribute it and/or modify it under
   5 the terms of the GNU General Public License as published by the Free
   6 Software Foundation; either version 2, or (at your option) any later
   7 version.
   8
   9 Pazpar2 is distributed in the hope that it will be useful, but WITHOUT ANY
  10 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12 for more details.
  13
  14 You should have received a copy of the GNU General Public License
  15 along with this program; if not, write to the Free Software
  16 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  17
  18 */
  19
  20 /** \file client.h
  21     \brief Z39.50 client
  22 */
  23
  24 #ifndef CLIENT_H
  25 #define CLIENT_H
  26
  27 struct client;
  28 struct connection;
  29
  30 enum client_state
  31 {
  32     Client_Connecting,
  33     Client_Connected,
  34     Client_Idle,
  35     Client_Initializing,
  36     Client_Searching,
  37     Client_Presenting,
  38     Client_Error,
  39     Client_Failed,
  40     Client_Disconnected,
  41     Client_Stopped,
  42     Client_Continue
  43 };
  44
  45 int client_show_raw_begin(struct client *cl, int position,
  46                           const char *syntax, const char *esn,
  47                           void *data,
  48                           void (*error_handler)(void *data, const char *addinfo),
  49                           void (*record_handler)(void *data, const char *buf,
  50                                                  size_t sz),
  51                           void **data2,
  52                           int binary);
  53 void client_show_raw_remove(struct client *cl, void *rr);
  54
  55 const char *client_get_state_str(struct client *cl);
  56 enum client_state client_get_state(struct client *cl);
  57 void client_set_state(struct client *cl, enum client_state st);
  58 void client_fatal(struct client *cl);
  59 struct connection *client_get_connection(struct client *cl);
  60 struct session_database *client_get_database(struct client *cl);
  61 void client_set_database(struct client *cl, struct session_database *db);
  62 struct session *client_get_session(struct client *cl);
  63 const char *client_get_pquery(struct client *cl);
  64
  65 void client_set_requestid(struct client *cl, int id);
  66
  67 void client_init_response(struct client *cl, Z_APDU *a);
  68 void client_search_response(struct client *cl, Z_APDU *a);
  69 void client_present_response(struct client *cl, Z_APDU *a);
  70 void client_close_response(struct client *cl, Z_APDU *a);
  71
  72 int client_is_our_response(struct client *cl);
  73
  74 void client_continue(struct client *cl);
  75
  76 struct client *client_create(void);
  77 void client_destroy(struct client *c);
  78
  79 void client_set_connection(struct client *cl, struct connection *con);
  80 void client_disconnect(struct client *cl);
  81 int client_prep_connection(struct client *cl);
  82 void client_set_session(struct client *cl, struct session *se);
  83 int client_is_active(struct client *cl);
  84 struct client *client_next_in_session(struct client *cl);
  85
  86 int client_parse_query(struct client *cl, const char *query);
  87 int client_get_hits(struct client *cl);
  88 int client_get_num_records(struct client *cl);
  89 int client_get_diagnostic(struct client *cl);
  90 void client_set_database(struct client *cl, struct session_database *db);
  91 struct host *client_get_host(struct client *cl);
  92 const char *client_get_url(struct client *cl);
  93
  94 #endif
  95
  96 /*
  97  * Local variables:
  98  * c-basic-offset: 4
  99  * indent-tabs-mode: nil
 100  * End:
 101  * vim: shiftwidth=4 tabstop=8 expandtab
 102  */