File: signalable.h

package info (click to toggle)
process-cpp 3.0.2-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 632 kB
  • sloc: cpp: 2,545; ansic: 228; makefile: 17
file content (62 lines) | stat: -rw-r--r-- 1,798 bytes parent folder | download | duplicates (5)
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
/*
 * Copyright © 2013 Canonical Ltd.
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License version 3,
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * Authored by: Thomas Voß <thomas.voss@canonical.com>
 */

#ifndef CORE_POSIX_SIGNALABLE_H_
#define CORE_POSIX_SIGNALABLE_H_

#include <core/posix/signal.h>
#include <core/posix/visibility.h>

#include <memory>
#include <system_error>

namespace core
{
namespace posix
{
/**
 * @brief The Signalable class abstracts the ability of an entity to be delivered a posix signal.
 */
class CORE_POSIX_DLL_PUBLIC Signalable
{
public:
    /**
     * @brief Sends a signal to this signalable object.
     * @throws std::system_error in case of problems.
     * @param [in] signal The signal to be sent to the process.
     */
    virtual void send_signal_or_throw(Signal signal);

    /**
     * @brief Sends a signal to this signalable object.
     * @param [in] signal The signal to be sent to the process.
     * @param [out] e Set to contain an error if an issue arises.
     */
    virtual void send_signal(Signal signal, std::error_code& e) noexcept(true);

protected:
    CORE_POSIX_DLL_LOCAL explicit Signalable(pid_t pid);

private:
    struct CORE_POSIX_DLL_LOCAL Private;
    std::shared_ptr<Private> d;
};
}
}

#endif // CORE_POSIX_SIGNALABLE_H_