include/yaz-socket-observer.h

   1 /*
   2  * Copyright (c) 1998-1999, Index Data.
   3  * See the file LICENSE for details.
   4  * Sebastian Hammer, Adam Dickmeiss
   5  *
   6  * $Log: yaz-socket-observer.h,v $
   7  * Revision 1.2  1999-02-02 14:01:17  adam
   8  * First WIN32 port of YAZ++.
   9  *
  10  * Revision 1.1.1.1  1999/01/28 09:41:07  adam
  11  * First implementation of YAZ++.
  12  *
  13  */
  14
  15 #ifndef YAZ_SOCKET_OBSERVER_H
  16 #define YAZ_SOCKET_OBSERVER_H
  17
  18 #define YAZ_SOCKET_OBSERVE_READ 1
  19 #define YAZ_SOCKET_OBSERVE_WRITE 2
  20 #define YAZ_SOCKET_OBSERVE_EXCEPT 4
  21 #define YAZ_SOCKET_OBSERVE_TIME 8
  22
  23 /**
  24    Forward reference
  25  */
  26 class IYazSocketObserver;
  27
  28 /** Socket Observable.
  29    This interface implements notification of socket events.
  30    The module interested in (observing) the sockets
  31    must implement the IYazSocketObserver interface. The
  32    IYazSocketObserver only have to implement one function, so it's
  33    quite simple to observe sockets change state.
  34    The socket events below specifies read, write, exception,
  35    and timeout respectively:
  36    <pre>
  37     YAZ_SOCKET_OBSERVE_READ
  38     YAZ_SOCKET_OBSERVE_WRITE
  39     YAZ_SOCKET_OBSERVE_EXCEPT
  40     YAZ_SOCKET_OBSERVE_TIMEOUT
  41     </pre>
  42     The maskObserver method specifies which of these events the
  43     observer is intertested in.
  44 */
  45 class YAZ_EXPORT IYazSocketObservable {
  46  public:
  47     /// Add an observer interested in socket fd
  48     virtual void addObserver(int fd, IYazSocketObserver *observer) = 0;
  49     /// Delete an observer
  50     virtual void deleteObserver(IYazSocketObserver *observer) = 0;
  51     /// Delete all observers
  52     virtual void deleteObservers() = 0;
  53     /// Specify the events that the observer is intersted in.
  54     virtual void maskObserver(IYazSocketObserver *observer, int mask) = 0;
  55     /// Specify timeout
  56     virtual void timeoutObserver(IYazSocketObserver *observer,
  57                                  unsigned timeout)=0;
  58 };
  59
  60 /** Socket Observer.
  61    The IYazSocketObserver interface implements a module interested
  62    socket events. Look for objects that implements the
  63    IYazSocketObservable interface!
  64 */
  65 class YAZ_EXPORT IYazSocketObserver {
  66  public:
  67     /// Notify the observer that something happened to socket
  68     virtual void socketNotify(int event) = 0;
  69 };
  70
  71 #endif