1 // $Id: master-header,v 1.11 2002-11-25 13:33:22 mike Exp $
4 // The ZOOM homepage is at http://zoom.z3950.org/
6 // Derived from version 1.0g at
7 // http://zoom.z3950.org/bind/cplusplus/zoom-1.0g.hh
9 #include <stddef.h> // for size_t
14 * * This is a bit stupid. The fact that our ZOOM-C++ implementation is
15 * * based on the ZOOM-C implementation is our Dirty Little Secret, and
16 * * there is in principle no reason why client code need be bothered
17 * * with it. Except of course that the public class declarations in
18 * * C++ have to lay their private parts out for the world to see
19 * * (oo-er). Hence the inclusion of <yaz/zoom.h>
21 *#include <yaz/zoom.h>
24 // Forward declarations for type names.
25 class YAZ_EXPORT query;
26 class YAZ_EXPORT resultSet;
27 class YAZ_EXPORT record;
29 class YAZ_EXPORT connection {
31 * friend class resultSet; // so it can use _getYazConnection()
32 * ZOOM_connection _getYazConnection () const { return c; }
33 // connections are non-copyable.
34 connection (const connection &);
35 connection &operator= (const connection &);
38 connection (const std::string &hostname, int portnum);
40 void connect (const std::string &hostname, int portnum);
41 std::string option (const std::string &key) const;
42 bool option (const std::string &key, const std::string &val);
46 // base class for all query types
47 * friend class resultSet; // so it can use _getYazQuery()
48 * ZOOM_query _getYazQuery () const { return q; }
55 class YAZ_EXPORT prefixQuery : public query {
57 prefixQuery (const std::string &pqn);
61 class YAZ_EXPORT CCLQuery : public query {
63 CCLQuery (const std::string &ccl, void *qualset);
67 class YAZ_EXPORT resultSet {
70 // resultSets are non-copyable.
71 resultSet (const resultSet &);
72 resultSet &operator= (const resultSet &);
74 resultSet (connection &c, const query &q);
76 std::string option (const std::string &key) const;
77 bool option (const std::string &key, const std::string &val);
81 class YAZ_EXPORT record {
82 * const resultSet *owner;
84 * friend class resultSet; // so it can use this constructor
85 * record::record (const resultSet *rs, ZOOM_record rec):
86 * owner (rs), r (rec) {}
91 UNKNOWN, GRS1, SUTRS, USMARC, UKMARC, XML
93 syntax (value rs) : i(rs) {};
94 operator std::string () const;
95 bool operator== (const syntax &s) const;
96 bool operator== (value rs) const;
97 operator value () const;
100 record (resultSet &rs, size_t num);
102 syntax recsyn () const;
103 std::string render () const;
104 std::string rawdata () const;
107 // Base exception class; from which all other ZOOM exceptions
108 // are derived. Other classes that use this as their base
109 // class may want to provide their own errcode() and errmsg()
110 // functions -- hence they are made virtual.
111 class YAZ_EXPORT exception {
115 exception (int code);
116 virtual ~exception ();
117 virtual int errcode () const;
118 virtual std::string errmsg () const;
121 // systemException could be thrown for timeouts, protocol errors,
123 class YAZ_EXPORT systemException : public exception {
125 systemException (); // Uses value of system `errno'
126 systemException (int code);
129 // bib1Exception::errcode() returns a code from the
130 // Bib-1 Diagnostic Set.
131 class YAZ_EXPORT bib1Exception: public exception {
135 bib1Exception (int code, const std::string &addinfo);
136 std::string addinfo () const;
139 class YAZ_EXPORT queryException : public exception {
142 * ~queryException ();
143 enum { PREFIX, CCL };
144 queryException (int qtype, const std::string &source);
145 std::string addinfo () const;