include/yazpp/socket-manager.h

   1 /* This file is part of the yazpp toolkit.
   2  * Copyright (C) 1998-2012 Index Data and Mike Taylor
   3  * All rights reserved.
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are met:
   6  *
   7  *     * Redistributions of source code must retain the above copyright
   8  *       notice, this list of conditions and the following disclaimer.
   9  *     * Redistributions in binary form must reproduce the above copyright
  10  *       notice, this list of conditions and the following disclaimer in the
  11  *       documentation and/or other materials provided with the distribution.
  12  *     * Neither the name of Index Data nor the names of its contributors
  13  *       may be used to endorse or promote products derived from this
  14  *       software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
  17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  19  * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
  20  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  23  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27
  28 #ifndef YAZ_SOCKET_MANAGER_INCLUDED
  29 #define YAZ_SOCKET_MANAGER_INCLUDED
  30
  31 #include <yazpp/socket-observer.h>
  32
  33 struct yaz_poll_fd;
  34 namespace yazpp_1 {
  35
  36 /** Simple Socket Manager.
  37     Implements a stand-alone simple model that uses select(2) to
  38     observe socket events.
  39 */
  40 class YAZ_EXPORT SocketManager : public ISocketObservable {
  41  private:
  42     struct SocketEntry;
  43     struct SocketEvent;
  44     struct Rep;
  45
  46     Rep *m_p;
  47
  48     SocketEntry **lookupObserver(ISocketObserver *observer);
  49     SocketEvent *getEvent();
  50     void putEvent(SocketEvent *event);
  51     void removeEvent(ISocketObserver *observer);
  52     void inspect_poll_result(int res, struct yaz_poll_fd *fds, int no_fds,
  53                              int timeout);
  54  public:
  55     /// Add an observer
  56     virtual void addObserver(int fd, ISocketObserver *observer);
  57     /// Delete an observer
  58     virtual void deleteObserver(ISocketObserver *observer);
  59     /// Delete all observers
  60     virtual void deleteObservers();
  61     /// Set event mask for observer
  62     virtual void maskObserver(ISocketObserver *observer, int mask);
  63     /// Set timeout
  64     virtual void timeoutObserver(ISocketObserver *observer,
  65                                  int timeout);
  66     /// Process one event. return > 0 if event could be processed;
  67     int processEvent();
  68     int getNumberOfObservers();
  69     SocketManager();
  70     virtual ~SocketManager();
  71 };
  72
  73 };
  74
  75 #endif
  76 /*
  77  * Local variables:
  78  * c-basic-offset: 4
  79  * c-file-style: "Stroustrup"
  80  * indent-tabs-mode: nil
  81  * End:
  82  * vim: shiftwidth=4 tabstop=8 expandtab
  83  */
  84