Fix documentation build under maverick (doxygen 1.7.1)
[senf.git] / senf / Scheduler / SignalEvent.ih
1 // $Id$
2 //
3 // Copyright (C) 2008
4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
6 //     Stefan Bund <g0dil@berlios.de>
7 //
8 // This program is free software; you can redistribute it and/or modify
9 // it under the terms of the GNU General Public License as published by
10 // the Free Software Foundation; either version 2 of the License, or
11 // (at your option) any later version.
12 //
13 // This program is distributed in the hope that it will be useful,
14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 // GNU General Public License for more details.
17 //
18 // You should have received a copy of the GNU General Public License
19 // along with this program; if not, write to the
20 // Free Software Foundation, Inc.,
21 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
22
23 /** \file
24     \brief SignalDispatcher internal header */
25
26 #ifndef IH_SENF_Scheduler_SignalEvent_
27 #define IH_SENF_Scheduler_SignalEvent_ 1
28
29 // Custom includes
30 #include "FdManager.hh"
31 #include <senf/boost_intrusive/iset.hpp>
32 #include <senf/Utils/Exception.hh>
33 #include <senf/Utils/singleton.hh>
34
35 //-/////////////////////////////////////////////////////////////////////////////////////////////////
36
37 namespace senf {
38 namespace scheduler {
39
40     void restart();
41
42 namespace detail {
43
44     struct SignalSetCompare {
45         bool operator()(SignalEvent const & a, SignalEvent const & b) const
46             { return a.signal_ < b.signal_; }
47     };
48
49     struct FindNumericSignal {
50         bool operator()(SignalEvent const & a, int b) const
51             { return a.signal_ < b; }
52         bool operator()(int a, SignalEvent const & b) const
53             { return a < b.signal_; }
54     };
55
56     class SignalDispatcher
57         : public detail::FdManager::Event,
58           public singleton<SignalDispatcher>
59     {
60         typedef boost::intrusive::iset< SignalSetBase::value_traits<SignalEvent>,
61                                         SignalSetCompare,
62                                         false > SignalSet;
63     public:
64         using singleton<SignalDispatcher>::instance;
65         using singleton<SignalDispatcher>::alive;
66
67         void add(SignalEvent & event);
68         void remove(SignalEvent & event);
69
70         void unblockSignals();
71         void blockSignals();
72
73         bool empty() const;
74
75         struct DuplicateSignalRegistrationException : public Exception
76         { DuplicateSignalRegistrationException()
77               : Exception("duplicate signal registration") {} };
78
79     protected:
80
81     private:
82         SignalDispatcher();
83         ~SignalDispatcher();
84
85         virtual void signal(int events);
86         static void sigHandler(int signal, ::siginfo_t * siginfo, void *);
87
88         SignalSet handlers_;
89
90         int sigPipe_[2];
91
92         bool blocked_;
93         sigset_t sigSet_;
94
95         friend void senf::scheduler::restart();
96         friend class senf::scheduler::SignalEvent;
97         friend class singleton<SignalDispatcher>;
98     };
99
100 }}}
101
102 //-/////////////////////////////////////////////////////////////////////////////////////////////////
103 #endif
104
105 \f
106 // Local Variables:
107 // mode: c++
108 // fill-column: 100
109 // comment-column: 40
110 // c-file-style: "senf"
111 // indent-tabs-mode: nil
112 // ispell-local-dictionary: "american"
113 // compile-command: "scons -u test"
114 // End: