sigInt.C
Go to the documentation of this file.
1/*---------------------------------------------------------------------------*\
2 ========= |
3 \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4 \\ / O peration |
5 \\ / A nd | www.openfoam.com
6 \\/ M anipulation |
7-------------------------------------------------------------------------------
8 Copyright (C) 2011-2015 OpenFOAM Foundation
9 Copyright (C) 2018-2021 OpenCFD Ltd.
10-------------------------------------------------------------------------------
11License
12 This file is part of OpenFOAM.
13
14 OpenFOAM is free software: you can redistribute it and/or modify it
15 under the terms of the GNU General Public License as published by
16 the Free Software Foundation, either version 3 of the License, or
17 (at your option) any later version.
18
19 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22 for more details.
23
24 You should have received a copy of the GNU General Public License
25 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26
27\*---------------------------------------------------------------------------*/
28
29#include "sigInt.H"
30#include "error.H"
31#include "JobInfo.H"
32#include "IOstreams.H"
33
34// File-local functions
35#include "signalMacros.C"
36
37
38// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
39
40bool Foam::sigInt::sigActive_ = false;
41
42
43// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
44
45void Foam::sigInt::sigHandler(int)
46{
47 resetHandler("SIGINT", SIGINT);
48
49 JobInfo::shutdown(); // From running -> finished
50 ::raise(SIGINT); // Throw signal (to old handler)
51}
52
53
54// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
55
57{
58 set(false);
59}
60
61
62// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
63
65{
66 unset(false);
67}
68
69
70// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
71
72void Foam::sigInt::set(bool)
73{
74 if (sigActive_)
75 {
76 return;
77 }
78 sigActive_ = true;
79
80 setHandler("SIGINT", SIGINT, sigHandler);
81}
82
83
84void Foam::sigInt::unset(bool)
85{
86 if (!sigActive_)
87 {
88 return;
89 }
90 sigActive_ = false;
91
92 resetHandler("SIGINT", SIGINT);
93}
94
95
96// ************************************************************************* //
Useful combination of include files which define Sin, Sout and Serr and the use of IO streams general...
File-local code for setting/resetting signal handlers.
static void shutdown()
Simple shutdown (finalize) of JobInfo.
Definition: JobInfo.C:98
~sigInt()
Destructor.
Definition: sigInt.C:65
sigInt()
Construct null.
Definition: sigInt.C:57
static const triad unset
Definition: triad.H:97
bool set() const
Are all the vector set.
Definition: triadI.H:76
void set(List< bool > &bools, const labelUList &locations)
Set the listed locations (assign 'true').
Definition: BitOps.C:38
void unset(List< bool > &bools, const labelUList &locations)
Unset the listed locations (assign 'false').
Definition: BitOps.C:107
static void setHandler(const char *what, int sigNum, void(*handler)(int))
Definition: signalMacros.C:61
static void resetHandler(const char *what, int sigNum)
Definition: signalMacros.C:46