Implemented session timeout; ping command

[pazpar2-moved-to-github.git] / pazpar2.h

diff --git a/pazpar2.h b/pazpar2.h
index cb4e70f..a14d691 100644 (file)
--- a/pazpar2.h
+++ b/pazpar2.h
@@ -3,35 +3,108 @@
 
 struct record;
 
+#include <netdb.h>
+
+#include <yaz/comstack.h>
 #include <yaz/pquery.h>
+#include <yaz/ccl.h>
+#include <yaz/yaz-ccl.h>
 #include "termlists.h"
 #include "relevance.h"
+#include "eventl.h"
+
+#define MAX_DATABASES 512
 
 struct record {
-    struct target *target;
+    struct client *client;
     int target_offset;
     char *buf;
     char *merge_key;
+    char *title;
     int relevance;
     int *term_frequency_vec;
     struct record *next_cluster;
 };
 
+struct connection;
+
+// Represents a host (irrespective of databases)
+struct host {
+    char *hostport;
+    char *ipport;
+    struct connection *connections; // All connections to this
+    struct host *next;
+};
+
+// Represents a (virtual) database on a host
+struct database {
+    struct host *host;
+    char *url;
+    char databases[MAX_DATABASES][128];
+    int errors;
+    struct database *next;
+};
+
+struct client;
+
+// Represents a physical, reusable  connection to a remote Z39.50 host
+struct connection {
+    IOCHAN iochan;
+    COMSTACK link;
+    struct host *host;
+    struct client *client;
+    char *ibuf;
+    int ibufsize;
+    enum {
+        Conn_Connecting,
+        Conn_Open,
+        Conn_Waiting,
+    } state;
+    struct connection *next;
+};
+
+// Represents client state for a connection to one search target
+struct client {
+    struct database *database;
+    struct connection *connection;
+    struct session *session;
+    int hits;
+    int records;
+    int setno;
+    int requestid;                              // ID of current outstanding request
+    int diagnostic;
+    enum client_state
+    {
+        Client_Connecting,
+        Client_Connected,
+       Client_Idle,
+        Client_Initializing,
+        Client_Searching,
+        Client_Presenting,
+        Client_Error,
+        Client_Failed,
+        Client_Disconnected,
+        Client_Stopped
+    } state;
+    struct client *next;
+};
+
+// End-user session
 struct session {
-    struct target *targets;
-    YAZ_PQF_Parser pqf_parser;
+    struct client *clients;
     int requestid; 
     char query[1024];
-    NMEM nmem;
-    WRBUF wrbuf;
+    NMEM nmem;          // Nmem for each operation (i.e. search)
+    WRBUF wrbuf;        // Wrbuf for scratch(i.e. search)
     struct termlist *termlist;
     struct relevance *relevance;
     struct reclist *reclist;
-    yaz_marc_t yaz_marc;
+    int total_hits;
+    int total_records;
 };
 
 struct statistics {
-    int num_connections;
+    int num_clients;
     int num_no_connection;
     int num_connecting;
     int num_initializing;
@@ -40,6 +113,8 @@ struct statistics {
     int num_idle;
     int num_failed;
     int num_error;
+    int num_hits;
+    int num_records;
 };
 
 struct hitsbytarget {
@@ -48,15 +123,32 @@ struct hitsbytarget {
     int diagnostic;
     int records;
     char* state;
+    int connected;
+};
+
+struct parameters {
+    int timeout;               /* operations timeout, in seconds */
+    char implementationId[128];
+    char implementationName[128];
+    char implementationVersion[128];
+    int target_timeout; // seconds
+    int session_timeout;
+    int toget;
+    int chunk;
+    CCL_bibset ccl_filter;
+    yaz_marc_t yaz_marc;
+    ODR odr_out;
+    ODR odr_in;
 };
 
 struct hitsbytarget *hitsbytarget(struct session *s, int *count);
+int select_targets(struct session *se);
 struct session *new_session();
-void session_destroy(struct session *s);
+void destroy_session(struct session *s);
 int load_targets(struct session *s, const char *fn);
 void statistics(struct session *s, struct statistics *stat);
-void search(struct session *s, char *query);
-struct record **show(struct session *s, int start, int *num);
+char *search(struct session *s, char *query);
+struct record **show(struct session *s, int start, int *num, int *total, int *sumhits);
 struct termlist_score **termlist(struct session *s, int *num);
 
 #endif