aboutsummaryrefslogtreecommitdiffstats
path: root/include/distortos/SignalAction.hpp
blob: d91d6969c61bed58cfb3f0b34a0efa48696f68ea (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
/**
 * \file
 * \brief SignalAction class header
 *
 * \author Copyright (C) 2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info
 *
 * \par License
 * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not
 * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */

#ifndef INCLUDE_DISTORTOS_SIGNALACTION_HPP_
#define INCLUDE_DISTORTOS_SIGNALACTION_HPP_

#include "distortos/SignalSet.hpp"

namespace distortos
{

class SignalInformation;

/**
 * \brief SignalAction class contains information needed to handle signal that was caught
 *
 * Similar to \a sigaction - http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/signal.h.html
 *
 * \ingroup signals
 */

class SignalAction
{
public:

	/// handler function
	using Handler = void(const SignalInformation&);

	/**
	 * \brief SignalAction's constructor which uses "default" signal handler.
	 */

	constexpr SignalAction() :
			signalMask_{SignalSet::empty},
			handler_{}
	{

	}

	/**
	 * \brief SignalAction's constructor.
	 *
	 * \param [in] handler is a reference to handler function (similar to \a sa_sigaction member of \a sigaction)
	 * \param [in] signalMask is the additional set of signals to be masked during execution of signal-catching function
	 * (similar to \a sa_mask member of \a sigaction)
	 */

	constexpr SignalAction(Handler& handler, const SignalSet signalMask) :
			signalMask_{signalMask},
			handler_{&handler}
	{

	}

	/**
	 * \return pointer to handler function (similar to \a sa_sigaction member of \a sigaction), nullptr if use of
	 * default handler was configured (similar to \a SIG_DFL)
	 */

	Handler* getHandler() const
	{
		return handler_;
	}

	/**
	 * \return additional set of signals to be masked during execution of signal-catching function (similar to
	 * \a sa_mask member of \a sigaction)
	 */

	SignalSet getSignalMask() const
	{
		return signalMask_;
	}

private:

	/// additional set of signals to be masked during execution of signal-catching function (similar to \a sa_mask
	/// member of \a sigaction)
	SignalSet signalMask_;

	/// pointer to handler function (similar to \a sa_sigaction member of \a sigaction), nullptr to use default handler
	/// (similar to \a SIG_DFL)
	Handler* handler_;
};

}	// namespace distortos

#endif	// INCLUDE_DISTORTOS_SIGNALACTION_HPP_