2 * Copyright (c) 1998-2000, Index Data.
3 * See the file LICENSE for details.
5 * $Id: yaz-socket-observer.h,v 1.5 2000-09-08 10:23:42 adam Exp $
8 #ifndef YAZ_SOCKET_OBSERVER_H
9 #define YAZ_SOCKET_OBSERVER_H
11 #define YAZ_SOCKET_OBSERVE_READ 1
12 #define YAZ_SOCKET_OBSERVE_WRITE 2
13 #define YAZ_SOCKET_OBSERVE_EXCEPT 4
14 #define YAZ_SOCKET_OBSERVE_TIMEOUT 8
19 class IYazSocketObserver;
21 /** Socket Observable.
22 This interface implements notification of socket events.
23 The module interested in (observing) the sockets
24 must implement the IYazSocketObserver interface. The
25 IYazSocketObserver only have to implement one function, so it's
26 quite simple to observe sockets change state.
27 The socket events below specifies read, write, exception,
28 and timeout respectively:
30 YAZ_SOCKET_OBSERVE_READ
31 YAZ_SOCKET_OBSERVE_WRITE
32 YAZ_SOCKET_OBSERVE_EXCEPT
33 YAZ_SOCKET_OBSERVE_TIMEOUT
35 The maskObserver method specifies which of these events the
36 observer is intertested in.
38 class YAZ_EXPORT IYazSocketObservable {
40 /// Add an observer interested in socket fd
41 virtual void addObserver(int fd, IYazSocketObserver *observer) = 0;
42 /// Delete an observer
43 virtual void deleteObserver(IYazSocketObserver *observer) = 0;
44 /// Delete all observers
45 virtual void deleteObservers() = 0;
46 /// Specify the events that the observer is intersted in.
47 virtual void maskObserver(IYazSocketObserver *observer, int mask) = 0;
49 virtual void timeoutObserver(IYazSocketObserver *observer,
54 The IYazSocketObserver interface implements a module interested
55 socket events. Look for objects that implements the
56 IYazSocketObservable interface!
58 class YAZ_EXPORT IYazSocketObserver {
60 /// Notify the observer that something happened to socket
61 virtual void socketNotify(int event) = 0;