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