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
|
// 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 <cstring>
#include "pw_bytes/span.h"
#include "pw_rpc/internal/call_context.h"
#include "pw_rpc/internal/server_call.h"
#include "pw_rpc/method_type.h"
namespace pw::rpc::internal::test {
// Fake server reader/writer classes for testing use. These also serve as a
// model for how the RPC implementations (raw, pwpb, Nanopb) structure their
// reader/writer classes.
//
// Readers/writers use an unusual inheritance hierarchy. Rather than having the
// ServerReaderWriter inherit from both the Reader and Writer classes, the
// readers and writers inherit from it, but hide the unsupported functionality.
// A ReaderWriter defines conversions to Reader and Writer, so it acts as if it
// inherited from both. This approach is unusual but necessary to have all
// classes use a single IntrusiveList::Item base and to avoid virtual methods or
// virtual inheritance.
//
// Call's public API is intended for rpc::Server, so hide the public methods
// with private inheritance.
class FakeServerReaderWriter : private ServerCall {
public:
constexpr FakeServerReaderWriter() = default;
// On a real reader/writer, this constructor would not be exposed.
FakeServerReaderWriter(const LockedCallContext& context,
MethodType type = MethodType::kBidirectionalStreaming)
PW_EXCLUSIVE_LOCKS_REQUIRED(rpc_lock())
: ServerCall(context, CallProperties(type, kServerCall, kRawProto)) {}
FakeServerReaderWriter(FakeServerReaderWriter&&) = default;
FakeServerReaderWriter& operator=(FakeServerReaderWriter&&) = default;
// Pull in protected functions from the hidden Call base as needed.
//
// Note: these functions all acquire `rpc_lock()`. However, the
// `PW_LOCKS_EXCLUDED(rpc_lock())` on their original definitions does not
// appear to carry through here.
using Call::active;
using Call::set_on_error;
using Call::set_on_next;
using ServerCall::set_on_completion_requested;
using ServerCall::set_on_completion_requested_if_enabled;
Status Finish(Status status = OkStatus()) {
return CloseAndSendResponse(status);
}
using Call::Write;
// Expose a few additional methods for test use.
ServerCall& as_server_call() { return *this; }
using Call::channel_id_locked;
using Call::DebugLog;
using Call::id;
using Call::set_id;
};
class FakeServerWriter : private FakeServerReaderWriter {
public:
constexpr FakeServerWriter() = default;
FakeServerWriter(const LockedCallContext& context)
PW_EXCLUSIVE_LOCKS_REQUIRED(rpc_lock())
: FakeServerReaderWriter(context, MethodType::kServerStreaming) {}
FakeServerWriter(FakeServerWriter&&) = default;
FakeServerWriter& operator=(FakeServerWriter&&) = default;
// Common reader/writer functions.
using FakeServerReaderWriter::active;
using FakeServerReaderWriter::Finish;
using FakeServerReaderWriter::set_on_completion_requested;
using FakeServerReaderWriter::set_on_completion_requested_if_enabled;
using FakeServerReaderWriter::set_on_error;
using FakeServerReaderWriter::Write;
// Functions for test use.
using FakeServerReaderWriter::as_server_call;
};
class FakeServerReader : private FakeServerReaderWriter {
public:
constexpr FakeServerReader() = default;
FakeServerReader(const LockedCallContext& context)
PW_EXCLUSIVE_LOCKS_REQUIRED(rpc_lock())
: FakeServerReaderWriter(context, MethodType::kClientStreaming) {}
FakeServerReader(FakeServerReader&&) = default;
FakeServerReader& operator=(FakeServerReader&&) = default;
using FakeServerReaderWriter::active;
using FakeServerReaderWriter::as_server_call;
};
} // namespace pw::rpc::internal::test
|
