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
|
// Copyright 2022 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.
// This file defines the ServerReaderWriter, ServerReader, and ServerWriter
// classes for the raw RPC interface. These classes are used for bidirectional,
// client, and server streaming RPCs.
#pragma once
#include "pw_bytes/span.h"
#include "pw_rpc/channel.h"
#include "pw_rpc/internal/client_call.h"
#include "pw_rpc/writer.h"
namespace pw::rpc {
// Sends requests and handles responses for a bidirectional streaming RPC.
//
// These classes use private inheritance to hide the internal::Call API while
// allow direct use of its public and protected functions.
class RawClientReaderWriter : private internal::StreamResponseClientCall {
public:
constexpr RawClientReaderWriter() = default;
RawClientReaderWriter(RawClientReaderWriter&&) = default;
RawClientReaderWriter& operator=(RawClientReaderWriter&&) = default;
using internal::Call::active;
using internal::Call::channel_id;
using internal::ClientCall::id;
// Functions for setting the callbacks.
using internal::StreamResponseClientCall::set_on_completed;
using internal::StreamResponseClientCall::set_on_error;
using internal::StreamResponseClientCall::set_on_next;
// Sends a stream request packet with the given raw payload.
using internal::Call::Write;
// Notifies the server that the client has requested to stop communication by
// sending CLIENT_REQUEST_COMPLETION.
using internal::ClientCall::RequestCompletion;
// Cancels this RPC. Closes the call locally and sends a CANCELLED error to
// the server.
using internal::Call::Cancel;
// Closes this RPC locally. Sends a CLIENT_REQUEST_COMPLETION, but no
// cancellation packet. Future packets for this RPC are dropped, and the
// client sends a FAILED_PRECONDITION error in response because the call is
// not active.
using internal::ClientCall::Abandon;
// Allow use as a generic RPC Writer.
using internal::Call::operator Writer&;
using internal::Call::operator const Writer&;
private:
friend class internal::StreamResponseClientCall;
RawClientReaderWriter(internal::LockedEndpoint& client,
uint32_t channel_id,
uint32_t service_id,
uint32_t method_id)
PW_EXCLUSIVE_LOCKS_REQUIRED(internal::rpc_lock())
: StreamResponseClientCall(
client,
channel_id,
service_id,
method_id,
RawCallProps(MethodType::kBidirectionalStreaming)) {}
};
// Handles responses for a server streaming RPC.
class RawClientReader : private internal::StreamResponseClientCall {
public:
constexpr RawClientReader() = default;
RawClientReader(RawClientReader&&) = default;
RawClientReader& operator=(RawClientReader&&) = default;
using internal::StreamResponseClientCall::active;
using internal::StreamResponseClientCall::channel_id;
using internal::StreamResponseClientCall::set_on_completed;
using internal::StreamResponseClientCall::set_on_error;
using internal::StreamResponseClientCall::set_on_next;
using internal::Call::Cancel;
using internal::Call::RequestCompletion;
using internal::ClientCall::Abandon;
private:
friend class internal::StreamResponseClientCall;
RawClientReader(internal::LockedEndpoint& client,
uint32_t channel_id,
uint32_t service_id,
uint32_t method_id)
PW_EXCLUSIVE_LOCKS_REQUIRED(internal::rpc_lock())
: StreamResponseClientCall(client,
channel_id,
service_id,
method_id,
RawCallProps(MethodType::kServerStreaming)) {}
};
// Sends requests and handles the response for a client streaming RPC.
class RawClientWriter : private internal::UnaryResponseClientCall {
public:
constexpr RawClientWriter() = default;
RawClientWriter(RawClientWriter&&) = default;
RawClientWriter& operator=(RawClientWriter&&) = default;
~RawClientWriter() PW_LOCKS_EXCLUDED(internal::rpc_lock()) {
DestroyClientCall();
}
using internal::UnaryResponseClientCall::active;
using internal::UnaryResponseClientCall::channel_id;
using internal::UnaryResponseClientCall::set_on_completed;
using internal::UnaryResponseClientCall::set_on_error;
using internal::Call::Cancel;
using internal::Call::RequestCompletion;
using internal::Call::Write;
using internal::ClientCall::Abandon;
// Allow use as a generic RPC Writer.
using internal::Call::operator Writer&;
using internal::Call::operator const Writer&;
private:
friend class internal::UnaryResponseClientCall;
RawClientWriter(internal::LockedEndpoint& client,
uint32_t channel_id,
uint32_t service_id,
uint32_t method_id)
PW_EXCLUSIVE_LOCKS_REQUIRED(internal::rpc_lock())
: UnaryResponseClientCall(client,
channel_id,
service_id,
method_id,
RawCallProps(MethodType::kClientStreaming)) {}
};
// Handles the response for to unary RPC.
class RawUnaryReceiver : private internal::UnaryResponseClientCall {
public:
constexpr RawUnaryReceiver() = default;
RawUnaryReceiver(RawUnaryReceiver&&) = default;
RawUnaryReceiver& operator=(RawUnaryReceiver&&) = default;
~RawUnaryReceiver() PW_LOCKS_EXCLUDED(internal::rpc_lock()) {
DestroyClientCall();
}
using internal::UnaryResponseClientCall::active;
using internal::UnaryResponseClientCall::channel_id;
using internal::UnaryResponseClientCall::set_on_completed;
using internal::UnaryResponseClientCall::set_on_error;
using internal::ClientCall::Abandon;
using internal::UnaryResponseClientCall::Cancel;
private:
friend class internal::UnaryResponseClientCall;
RawUnaryReceiver(internal::LockedEndpoint& client,
uint32_t channel_id,
uint32_t service_id,
uint32_t method_id)
PW_EXCLUSIVE_LOCKS_REQUIRED(internal::rpc_lock())
: UnaryResponseClientCall(client,
channel_id,
service_id,
method_id,
RawCallProps(MethodType::kUnary)) {}
};
} // namespace pw::rpc
|
