FreeFOAM The Cross-Platform CFD Toolkit
sigQuitImpl.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) 1991-2010 OpenCFD Ltd.
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::sigQuitImpl
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  This is the platform specific opaque implementation for class sigQuit.
34 
35 See Also
36  Foam::JobInfo
37 
38 SourceFiles
39  sigQuitImpl.C
40 
41 \*---------------------------------------------------------------------------*/
42 
43 #ifndef sigQuitImpl_H
44 #define sigQuitImpl_H
45 
46 #include <OpenFOAM/OSspecific.H>
47 #include <signal.h>
48 
49 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
50 
51 namespace Foam
52 {
53 
54 /*---------------------------------------------------------------------------*\
55  Class sigQuitImpl Declaration
56 \*---------------------------------------------------------------------------*/
57 
59 {
60  // Private data
61 
62  //- Saved old signal trapping setting
63  static struct sigaction oldAction_;
64 
65 
66  // Private Member Functions
67 
68  static void sigQuitHandler(int);
69 
70 
71 public:
72 
73  // Constructors
74 
75  sigQuitImpl();
76 
77 
78  // Destructor
79 
80  ~sigQuitImpl();
81 
82 
83  // Member functions
84 
85  void set(const bool verbose);
86 };
87 
88 
89 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
90 
91 } // End namespace Foam
92 
93 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
94 
95 #endif
96 
97 // ************************ vim: set sw=4 sts=4 et: ************************ //