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