Happy new year
[yazpp-moved-to-github.git] / include / yazpp / socket-manager.h
1 /* This file is part of the yazpp toolkit.
2  * Copyright (C) 1998-2009 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 #include <time.h>
33
34 struct yaz_poll_fd;
35 namespace yazpp_1 {
36
37 /** Simple Socket Manager.
38     Implements a stand-alone simple model that uses select(2) to
39     observe socket events.
40 */
41 class YAZ_EXPORT SocketManager : public ISocketObservable {
42  private:
43     struct SocketEntry {
44         ISocketObserver *observer;
45         int fd;
46         unsigned mask;
47         int timeout;
48         int timeout_this;
49         time_t last_activity;
50         SocketEntry *next;
51     };
52     SocketEntry *m_observers;       // all registered observers
53     struct SocketEvent {
54         ISocketObserver *observer;
55         int event;
56         SocketEvent *next;          // front in queue
57         SocketEvent *prev;          // back in queue
58     };
59     SocketEvent *m_queue_front;
60     SocketEvent *m_queue_back;
61     
62     SocketEntry **lookupObserver
63         (ISocketObserver *observer);
64     SocketEvent *getEvent();
65     void putEvent(SocketEvent *event);
66     void removeEvent(ISocketObserver *observer);
67     int m_log;
68     void inspect_poll_result(int res, struct yaz_poll_fd *fds, int no_fds,
69                              int timeout);
70  public:
71     /// Add an observer
72     virtual void addObserver(int fd, ISocketObserver *observer);
73     /// Delete an observer
74     virtual void deleteObserver(ISocketObserver *observer);
75     /// Delete all observers
76     virtual void deleteObservers();
77     /// Set event mask for observer
78     virtual void maskObserver(ISocketObserver *observer, int mask);
79     /// Set timeout
80     virtual void timeoutObserver(ISocketObserver *observer,
81                                  int timeout);
82     /// Process one event. return > 0 if event could be processed;
83     int processEvent();
84     SocketManager();
85     virtual ~SocketManager();
86 };
87
88 };
89
90 #endif
91 /*
92  * Local variables:
93  * c-basic-offset: 4
94  * indent-tabs-mode: nil
95  * End:
96  * vim: shiftwidth=4 tabstop=8 expandtab
97  */
98