sigInt.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19  for more details.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 Class
25  Foam::sigInt
26 
27 Description
28  Signal handler for INT interupt.
29 
30  The standard interupt handler is overridden to ensure that the
31  runningJob file is removed.
32 
33 See also
34  Foam::JobInfo
35 
36 SourceFiles
37  sigInt.C
38 
39 \*---------------------------------------------------------------------------*/
40 
41 #ifndef sigInt_H
42 #define sigInt_H
43 
44 #include <signal.h>
45 
46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
47 
48 namespace Foam
49 {
50 
51 /*---------------------------------------------------------------------------*\
52  Class sigInt Declaration
53 \*---------------------------------------------------------------------------*/
54 
55 class sigInt
56 {
57  // Private data
58 
59  //- Saved old signal trapping setting
60  static struct sigaction oldAction_;
61 
62 
63  // Private Member Functions
64 
65  static void sigHandler(int);
66 
67 
68 public:
69 
70  // Constructors
71 
72  //- Construct null
73  sigInt();
74 
75 
76  //- Destructor
77  ~sigInt();
78 
79 
80  // Member functions
81 
82  //- Activate SIGINT signal handler
83  void set(const bool verbose);
84 };
85 
86 
87 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
88 
89 } // End namespace Foam
90 
91 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
92 
93 #endif
94 
95 // ************************************************************************* //
Signal handler for INT interupt.
Definition: sigInt.H:54
sigInt()
Construct null.
Definition: sigInt.C:58
~sigInt()
Destructor.
Definition: sigInt.C:66
Namespace for OpenFOAM.