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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
|
// Copyright 2021 The Pigweed Authors
//
// Licensed under the Apache License, Version 2.0 (the "License"); you may not
// use this file except in compliance with the License. You may obtain a copy of
// the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
// License for the specific language governing permissions and limitations under
// the License.
#pragma once
#include <cstdint>
#include "pw_bytes/span.h"
#include "pw_function/function.h"
#include "pw_rpc/internal/call.h"
#include "pw_rpc/internal/lock.h"
namespace pw::rpc::internal {
// A Call object, as used by an RPC client.
class ClientCall : public Call {
public:
~ClientCall() PW_LOCKS_EXCLUDED(rpc_lock()) {
rpc_lock().lock();
CloseClientCall();
rpc_lock().unlock();
}
protected:
constexpr ClientCall() = default;
ClientCall(Endpoint& client,
uint32_t channel_id,
uint32_t service_id,
uint32_t method_id,
MethodType type)
: Call(client, channel_id, service_id, method_id, type) {}
// Sends CLIENT_STREAM_END if applicable, releases any held payload buffer,
// and marks the call as closed.
void CloseClientCall() PW_EXCLUSIVE_LOCKS_REQUIRED(rpc_lock());
void MoveClientCallFrom(ClientCall& other)
PW_EXCLUSIVE_LOCKS_REQUIRED(rpc_lock()) {
CloseClientCall();
MoveFrom(other);
}
};
// Unary response client calls receive both a payload and the status in their
// on_completed callback. The on_next callback is not used.
class UnaryResponseClientCall : public ClientCall {
public:
template <typename CallType>
static CallType Start(Endpoint& client,
uint32_t channel_id,
uint32_t service_id,
uint32_t method_id,
Function<void(ConstByteSpan, Status)>&& on_completed,
Function<void(Status)>&& on_error,
ConstByteSpan request) PW_LOCKS_EXCLUDED(rpc_lock()) {
rpc_lock().lock();
CallType call(client, channel_id, service_id, method_id);
call.set_on_completed_locked(std::move(on_completed));
call.set_on_error_locked(std::move(on_error));
call.SendInitialClientRequest(request);
return call;
}
void HandleCompleted(ConstByteSpan response, Status status)
PW_UNLOCK_FUNCTION(rpc_lock()) {
const bool invoke_callback = on_completed_ != nullptr;
UnregisterAndMarkClosed();
rpc_lock().unlock();
if (invoke_callback) {
on_completed_(response, status);
}
}
protected:
constexpr UnaryResponseClientCall() = default;
UnaryResponseClientCall(Endpoint& client,
uint32_t channel_id,
uint32_t service_id,
uint32_t method_id,
MethodType type)
: ClientCall(client, channel_id, service_id, method_id, type) {}
UnaryResponseClientCall(UnaryResponseClientCall&& other) {
*this = std::move(other);
}
UnaryResponseClientCall& operator=(UnaryResponseClientCall&& other)
PW_LOCKS_EXCLUDED(rpc_lock()) {
LockGuard lock(rpc_lock());
MoveUnaryResponseClientCallFrom(other);
return *this;
}
void MoveUnaryResponseClientCallFrom(UnaryResponseClientCall& other)
PW_EXCLUSIVE_LOCKS_REQUIRED(rpc_lock()) {
MoveClientCallFrom(other);
on_completed_ = std::move(other.on_completed_);
}
void set_on_completed(Function<void(ConstByteSpan, Status)>&& on_completed)
PW_LOCKS_EXCLUDED(rpc_lock()) {
// TODO(pwbug/597): Ensure on_completed_ is properly guarded.
LockGuard lock(rpc_lock());
set_on_completed_locked(std::move(on_completed));
}
void set_on_completed_locked(
Function<void(ConstByteSpan, Status)>&& on_completed)
PW_EXCLUSIVE_LOCKS_REQUIRED(rpc_lock()) {
on_completed_ = std::move(on_completed);
}
private:
using internal::ClientCall::set_on_next; // Not used in unary response calls.
Function<void(ConstByteSpan, Status)> on_completed_;
};
// Stream response client calls only receive the status in their on_completed
// callback. Payloads are sent through the on_next callback.
class StreamResponseClientCall : public ClientCall {
public:
template <typename CallType>
static CallType Start(Endpoint& client,
uint32_t channel_id,
uint32_t service_id,
uint32_t method_id,
Function<void(ConstByteSpan)>&& on_next,
Function<void(Status)>&& on_completed,
Function<void(Status)>&& on_error,
ConstByteSpan request) {
rpc_lock().lock();
CallType call(client, channel_id, service_id, method_id);
call.set_on_next_locked(std::move(on_next));
call.set_on_completed_locked(std::move(on_completed));
call.set_on_error_locked(std::move(on_error));
call.SendInitialClientRequest(request);
return call;
}
void HandleCompleted(Status status) PW_UNLOCK_FUNCTION(rpc_lock()) {
const bool invoke_callback = on_completed_ != nullptr;
UnregisterAndMarkClosed();
rpc_lock().unlock();
// TODO(pwbug/597): Ensure on_completed_ is properly guarded.
if (invoke_callback) {
on_completed_(status);
}
}
protected:
constexpr StreamResponseClientCall() = default;
StreamResponseClientCall(Endpoint& client,
uint32_t channel_id,
uint32_t service_id,
uint32_t method_id,
MethodType type)
: ClientCall(client, channel_id, service_id, method_id, type) {}
StreamResponseClientCall(StreamResponseClientCall&& other) {
*this = std::move(other);
}
StreamResponseClientCall& operator=(StreamResponseClientCall&& other)
PW_LOCKS_EXCLUDED(rpc_lock()) {
LockGuard lock(rpc_lock());
MoveStreamResponseClientCallFrom(other);
return *this;
}
void MoveStreamResponseClientCallFrom(StreamResponseClientCall& other)
PW_EXCLUSIVE_LOCKS_REQUIRED(rpc_lock()) {
MoveClientCallFrom(other);
on_completed_ = std::move(other.on_completed_);
}
void set_on_completed(Function<void(Status)>&& on_completed)
PW_LOCKS_EXCLUDED(rpc_lock()) {
// TODO(pwbug/597): Ensure on_completed_ is properly guarded.
LockGuard lock(rpc_lock());
set_on_completed_locked(std::move(on_completed));
}
void set_on_completed_locked(Function<void(Status)>&& on_completed)
PW_EXCLUSIVE_LOCKS_REQUIRED(rpc_lock()) {
on_completed_ = std::move(on_completed);
}
private:
Function<void(Status)> on_completed_;
};
} // namespace pw::rpc::internal
|
