RSC  0.17.1
SignalWaiter.h
Go to the documentation of this file.
1 /* ============================================================
2  *
3  * This file is part of the RSC project
4  *
5  * Copyright (C) 2014 Jan Moringen <jmoringe@techfak.uni-bielefeld.de>
6  *
7  * This file may be licensed under the terms of the
8  * GNU Lesser General Public License Version 3 (the ``LGPL''),
9  * or (at your option) any later version.
10  *
11  * Software distributed under the License is distributed
12  * on an ``AS IS'' basis, WITHOUT WARRANTY OF ANY KIND, either
13  * express or implied. See the LGPL for the specific language
14  * governing rights and limitations.
15  *
16  * You should have received a copy of the LGPL along with this
17  * program. If not, go to http://www.gnu.org/licenses/lgpl.html
18  * or write to the Free Software Foundation, Inc.,
19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20  *
21  * The development of this software was supported by:
22  * CoR-Lab, Research Institute for Cognition and Robotics
23  * Bielefeld University
24  *
25  * ============================================================ */
26 
27 #pragma once
28 
29 #include <stdexcept>
30 
31 #include "rsc/rscexports.h"
32 
33 namespace rsc {
34 namespace misc {
35 
44 enum Signal {
45 
49  NO_SIGNAL = 0,
50 
57 
64 
71 
72 };
73 
97 RSC_EXPORT void initSignalWaiter(int signals
99 
113 RSC_EXPORT Signal waitForSignal();
114 
126 RSC_EXPORT Signal lastArrivedSignal();
127 
139 RSC_EXPORT int suggestedExitCode(Signal signal);
140 
141 }
142 }
void initSignalWaiter(int signals)
Prepare waiting for signals.
Signal waitForSignal()
Block until one of the signals specified in initSignalWaiter arrives, then return the signal...
Signal
Signals waitForSignal can wait for.
Definition: SignalWaiter.h:44
Artificial enum entry to indicate that no signal is meant at all.
Definition: SignalWaiter.h:49
Signal lastArrivedSignal()
Returns the last signal that has arrived at this process or Signal::NO_SIGNAL in case no signal arriv...
Interrupting the program has be requested.
Definition: SignalWaiter.h:56
int suggestedExitCode(Signal signal)
Return suggested exit code for exiting the program after receiving signal signal. ...
Quitting the program has be requested.
Definition: SignalWaiter.h:70
Terminating the program has be requested.
Definition: SignalWaiter.h:63