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
|
/*
* Copyright © 2012 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_DBUS_PENDING_CALL_H_
#define CORE_DBUS_PENDING_CALL_H_
#include <core/dbus/visibility.h>
#include <cstdint>
#include <functional>
#include <limits>
#include <memory>
namespace core
{
namespace dbus
{
class Message;
/**
* @brief The PendingCall class wraps an active call to a remote peer.
*/
class ORG_FREEDESKTOP_DBUS_DLL_PUBLIC PendingCall
{
public:
/**
* @brief Timeout constant for a call that never times out.
*/
inline static const std::chrono::milliseconds& inifinite_timeout()
{
static const std::chrono::milliseconds ms
{
std::numeric_limits<std::int32_t>::max()
};
return ms;
}
typedef std::shared_ptr<PendingCall> Ptr;
/** @brief Function signature callback for call completion notification. */
typedef std::function<void(const std::shared_ptr<Message>&)> Notification;
PendingCall(const PendingCall&) = delete;
virtual ~PendingCall() = default;
PendingCall& operator=(const PendingCall&) = delete;
bool operator==(const PendingCall&) const = delete;
/**
* @brief Cancels the outstanding call.
*/
virtual void cancel() = 0;
/**
* @brief Sets up notification as the callback when the call eventually completes.
* @param notification The function to be called when the call completes.
*/
virtual void then(const Notification& notification) = 0;
protected:
PendingCall() = default;
};
}
}
#endif // CORE_DBUS_PENDING_CALL_H_
|
