Rename yaz++ header files

[yazpp-moved-to-github.git] / include / yaz++ / pdu-observer.h

diff --git a/include/yaz++/pdu-observer.h b/include/yaz++/pdu-observer.h
new file mode 100644 (file)
index 0000000..02b5fe8
--- /dev/null
+++ b/include/yaz++/pdu-observer.h
@@ -0,0 +1,56 @@
+/*
+ * Copyright (c) 1998-2000, Index Data.
+ * See the file LICENSE for details.
+ * 
+ * $Id: pdu-observer.h,v 1.1 2002-10-09 12:50:26 adam Exp $
+ */
+
+#ifndef YAZ_PDU_OBSERVER_H
+#define YAZ_PDU_OBSERVER_H
+
+class IYaz_PDU_Observer;
+
+/** Protocol Data Unit Observable.
+    This interface implements a Protocol Data Unit (PDU) network driver.
+    The PDU's is not encoded/decoded by this interface. They are simply
+    transmitted/received over the network. To use this interface the
+    IYaz_PDU_Observer interface must be implemented.
+ */
+class YAZ_EXPORT IYaz_PDU_Observable {
+ public:
+    /// Send encoded PDU buffer of specified length
+    virtual int send_PDU(const char *buf, int len) = 0;
+    /// Connect with server specified by addr.
+    virtual void connect(IYaz_PDU_Observer *observer, const char *addr) = 0;
+    /// Listen on address addr.
+    virtual void listen(IYaz_PDU_Observer *observer, const char *addr) = 0;
+    /// Close connection
+    virtual void close() = 0;
+    /// Make clone of this object using this interface
+    virtual IYaz_PDU_Observable *clone() = 0;
+    /// Destroy completely
+    virtual void destroy() = 0;
+    /// Set Idle Time
+    virtual void idleTime (int timeout) = 0;
+};
+
+/** Protocol Data Unit Observer.
+    This interface is used together with the IYaz_PDU_Observable interface
+    and acts as a callback interface for it.
+ */
+class YAZ_EXPORT IYaz_PDU_Observer {
+ public:
+    /// A PDU has been received
+    virtual void recv_PDU(const char *buf, int len) = 0;
+    /// Called when Iyaz_PDU_Observable::connect was successful.
+    virtual void connectNotify() = 0;
+    /// Called whenever the connection was closed
+    virtual void failNotify() = 0;
+    /// Called whenever there is a timeout
+    virtual void timeoutNotify() = 0;
+    /// Make clone of observer using IYaz_PDU_Observable interface
+    virtual IYaz_PDU_Observer *sessionNotify(
+       IYaz_PDU_Observable *the_PDU_Observable, int fd) = 0;
+};
+
+#endif