Show command may re-search for targets that support it
[pazpar2-moved-to-github.git] / src / client.h
index fef4e6a..d7da767 100644 (file)
@@ -1,7 +1,5 @@
-/* $Id: client.h,v 1.6 2007-10-08 13:19:23 adam Exp $
-   Copyright (c) 2006-2007, Index Data.
-
-This file is part of Pazpar2.
+/* This file is part of Pazpar2.
+   Copyright (C) 2006-2011 Index Data
 
 Pazpar2 is free software; you can redistribute it and/or modify it under
 the terms of the GNU General Public License as published by the Free
@@ -14,10 +12,10 @@ FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 for more details.
 
 You should have received a copy of the GNU General Public License
-along with Pazpar2; see the file LICENSE.  If not, write to the
-Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
-02111-1307, USA.
- */
+along with this program; if not, write to the Free Software
+Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+
+*/
 
 /** \file client.h
     \brief Z39.50 client 
@@ -26,22 +24,19 @@ Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
 #ifndef CLIENT_H
 #define CLIENT_H
 
+#include "facet_limit.h"
+
 struct client;
 struct connection;
 
 enum client_state
 {
     Client_Connecting,
-    Client_Connected,
     Client_Idle,
-    Client_Initializing,
-    Client_Searching,
-    Client_Presenting,
+    Client_Working,
     Client_Error,
     Client_Failed,
-    Client_Disconnected,
-    Client_Stopped,
-    Client_Continue
+    Client_Disconnected
 };
 
 int client_show_raw_begin(struct client *cl, int position,
@@ -50,55 +45,72 @@ int client_show_raw_begin(struct client *cl, int position,
                           void (*error_handler)(void *data, const char *addinfo),
                           void (*record_handler)(void *data, const char *buf,
                                                  size_t sz),
-                          void **data2,
                           int binary);
+
 void client_show_raw_remove(struct client *cl, void *rr);
 
 const char *client_get_state_str(struct client *cl);
 enum client_state client_get_state(struct client *cl);
 void client_set_state(struct client *cl, enum client_state st);
-void client_fatal(struct client *cl);
 struct connection *client_get_connection(struct client *cl);
 struct session_database *client_get_database(struct client *cl);
 void client_set_database(struct client *cl, struct session_database *db);
 struct session *client_get_session(struct client *cl);
 const char *client_get_pquery(struct client *cl);
 
-void client_set_requestid(struct client *cl, int id);
-
 void client_init_response(struct client *cl, Z_APDU *a);
-void client_search_response(struct client *cl, Z_APDU *a);
-void client_present_response(struct client *cl, Z_APDU *a);
+void client_search_response(struct client *cl);
+void client_record_response(struct client *cl);
 void client_close_response(struct client *cl, Z_APDU *a);
 
 int client_is_our_response(struct client *cl);
 
 void client_continue(struct client *cl);
 
-struct client *client_create(void);
-void client_destroy(struct client *c);
+struct client *client_create(const char *url);
+int client_destroy(struct client *c);
 
 void client_set_connection(struct client *cl, struct connection *con);
 void client_disconnect(struct client *cl);
-int client_prep_connection(struct client *cl);
+int client_prep_connection(struct client *cl,
+                           int operation_timeout, int session_timeout,
+                           iochan_man_t iochan,
+                           const struct timeval *abstime);
+void client_start_search(struct client *cl, const char *sort_strategy,
+    const char *sort_spec);
 void client_set_session(struct client *cl, struct session *se);
 int client_is_active(struct client *cl);
+int client_is_active_preferred(struct client *cl);
 struct client *client_next_in_session(struct client *cl);
 
-int client_parse_query(struct client *cl, const char *query);
-int client_get_hits(struct client *cl);
+int client_parse_query(struct client *cl, const char *query,
+                       facet_limits_t facet_limits);
+Odr_int client_get_hits(struct client *cl);
 int client_get_num_records(struct client *cl);
 int client_get_diagnostic(struct client *cl);
+void client_set_diagnostic(struct client *cl, int diagnostic);
 void client_set_database(struct client *cl, struct session_database *db);
-struct host *client_get_host(struct client *cl);
-const char *client_get_url(struct client *cl);
+const char *client_get_id(struct client *cl);
+void client_set_maxrecs(struct client *cl, int v);
+int  client_get_maxrecs(struct client *cl);
+void client_set_startrecs(struct client *cl, int v);
+void client_remove_from_session(struct client *c);
+void client_incref(struct client *c);
+void client_got_records(struct client *c);
+void client_lock(struct client *c);
+void client_unlock(struct client *c);
+
+int client_has_facet(struct client *cl, const char *name);
+void client_check_preferred_watch(struct client *cl);
 
 #endif
 
 /*
  * Local variables:
  * c-basic-offset: 4
+ * c-file-style: "Stroustrup"
  * indent-tabs-mode: nil
  * End:
  * vim: shiftwidth=4 tabstop=8 expandtab
  */
+