sigQuit.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::sigQuit
26 
27 Description
28  Signal handler for QUIT 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  sigQuit.C
38 
39 \*---------------------------------------------------------------------------*/
40 
41 #ifndef sigQuit_H
42 #define sigQuit_H
43 
44 #include <signal.h>
45 
46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
47 
48 namespace Foam
49 {
50 
51 /*---------------------------------------------------------------------------*\
52  Class sigQuit Declaration
53 \*---------------------------------------------------------------------------*/
54 
55 class sigQuit
56 {
57  // Private data
58 
59  //- Saved old signal trapping setting
60  static struct sigaction oldAction_;
61 
62 
63  // Private Member Functions
64 
65  //- Handler for caught signals
66  static void sigHandler(int);
67 
68 
69 public:
70 
71  // Constructors
72 
73  //- Construct null
74  sigQuit();
75 
76 
77  //- Destructor
78  ~sigQuit();
79 
80 
81  // Member functions
82 
83  //- Activate SIGQUIT signal handler
84  void set(const bool verbose);
85 };
86 
87 
88 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
89 
90 } // End namespace Foam
91 
92 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
93 
94 #endif
95 
96 // ************************************************************************* //
Signal handler for QUIT interupt.
Definition: sigQuit.H:54
~sigQuit()
Destructor.
Definition: sigQuit.C:68
sigQuit()
Construct null.
Definition: sigQuit.C:60
Namespace for OpenFOAM.