Wyatt Hepler | cb9d957 | 2020-06-01 11:25:58 -0700 | [diff] [blame] | 1 | // Copyright 2020 The Pigweed Authors |
| 2 | // |
| 3 | // Licensed under the Apache License, Version 2.0 (the "License"); you may not |
| 4 | // use this file except in compliance with the License. You may obtain a copy of |
| 5 | // the License at |
| 6 | // |
| 7 | // https://www.apache.org/licenses/LICENSE-2.0 |
| 8 | // |
| 9 | // Unless required by applicable law or agreed to in writing, software |
| 10 | // distributed under the License is distributed on an "AS IS" BASIS, WITHOUT |
| 11 | // WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the |
| 12 | // License for the specific language governing permissions and limitations under |
| 13 | // the License. |
| 14 | |
Wyatt Hepler | 74e7ab6 | 2021-06-15 19:44:32 -0700 | [diff] [blame] | 15 | #include "pw_rpc/internal/responder.h" |
Wyatt Hepler | cb9d957 | 2020-06-01 11:25:58 -0700 | [diff] [blame] | 16 | |
Wyatt Hepler | f298de4 | 2021-03-19 15:06:36 -0700 | [diff] [blame] | 17 | #include "pw_assert/check.h" |
Wyatt Hepler | cb9d957 | 2020-06-01 11:25:58 -0700 | [diff] [blame] | 18 | #include "pw_rpc/internal/method.h" |
| 19 | #include "pw_rpc/internal/packet.h" |
Wyatt Hepler | 60fd70f | 2020-06-17 09:04:25 -0700 | [diff] [blame] | 20 | #include "pw_rpc/internal/server.h" |
Wyatt Hepler | cb9d957 | 2020-06-01 11:25:58 -0700 | [diff] [blame] | 21 | |
| 22 | namespace pw::rpc::internal { |
Wyatt Hepler | 5ba8064 | 2021-06-18 12:56:17 -0700 | [diff] [blame] | 23 | namespace { |
| 24 | |
| 25 | Packet ResponsePacket(const ServerCall& call, |
Wyatt Hepler | 01fc15b | 2021-06-10 18:15:59 -0700 | [diff] [blame] | 26 | std::span<const std::byte> payload, |
Wyatt Hepler | 5ba8064 | 2021-06-18 12:56:17 -0700 | [diff] [blame] | 27 | Status status) { |
| 28 | return Packet(PacketType::RESPONSE, |
| 29 | call.channel().id(), |
| 30 | call.service().id(), |
Wyatt Hepler | 01fc15b | 2021-06-10 18:15:59 -0700 | [diff] [blame] | 31 | call.method().id(), |
| 32 | payload, |
Wyatt Hepler | 5ba8064 | 2021-06-18 12:56:17 -0700 | [diff] [blame] | 33 | status); |
| 34 | } |
| 35 | |
| 36 | Packet StreamPacket(const ServerCall& call, |
Wyatt Hepler | 5ba8064 | 2021-06-18 12:56:17 -0700 | [diff] [blame] | 37 | std::span<const std::byte> payload) { |
| 38 | return Packet(PacketType::SERVER_STREAM, |
| 39 | call.channel().id(), |
| 40 | call.service().id(), |
Wyatt Hepler | 01fc15b | 2021-06-10 18:15:59 -0700 | [diff] [blame] | 41 | call.method().id(), |
Wyatt Hepler | 5ba8064 | 2021-06-18 12:56:17 -0700 | [diff] [blame] | 42 | payload); |
| 43 | } |
| 44 | |
| 45 | } // namespace |
Wyatt Hepler | cb9d957 | 2020-06-01 11:25:58 -0700 | [diff] [blame] | 46 | |
Wyatt Hepler | 01fc15b | 2021-06-10 18:15:59 -0700 | [diff] [blame] | 47 | Responder::Responder(ServerCall& call, HasClientStream has_client_stream) |
| 48 | : call_(call), |
| 49 | rpc_state_(kOpen), |
| 50 | has_client_stream_(has_client_stream), |
| 51 | client_stream_state_(has_client_stream ? kClientStreamOpen |
| 52 | : kClientStreamClosed) { |
Wyatt Hepler | 5180fe2 | 2021-06-15 19:32:08 -0700 | [diff] [blame] | 53 | call_.server().RegisterResponder(*this); |
Wyatt Hepler | 60fd70f | 2020-06-17 09:04:25 -0700 | [diff] [blame] | 54 | } |
| 55 | |
Wyatt Hepler | 5180fe2 | 2021-06-15 19:32:08 -0700 | [diff] [blame] | 56 | Responder& Responder::operator=(Responder&& other) { |
Wyatt Hepler | 01fc15b | 2021-06-10 18:15:59 -0700 | [diff] [blame] | 57 | CloseAndSendResponse(OkStatus()).IgnoreError(); |
Wyatt Hepler | b7643d7 | 2020-07-10 10:33:14 -0700 | [diff] [blame] | 58 | |
Wyatt Hepler | 01fc15b | 2021-06-10 18:15:59 -0700 | [diff] [blame] | 59 | // Move the state variables, which may change when the other client closes. |
| 60 | rpc_state_ = other.rpc_state_; |
| 61 | has_client_stream_ = other.has_client_stream_; |
| 62 | client_stream_state_ = other.client_stream_state_; |
Wyatt Hepler | b7643d7 | 2020-07-10 10:33:14 -0700 | [diff] [blame] | 63 | |
| 64 | if (other.open()) { |
Wyatt Hepler | 01fc15b | 2021-06-10 18:15:59 -0700 | [diff] [blame] | 65 | other.Close(); |
Wyatt Hepler | 5180fe2 | 2021-06-15 19:32:08 -0700 | [diff] [blame] | 66 | other.call_.server().RegisterResponder(*this); |
Wyatt Hepler | b7643d7 | 2020-07-10 10:33:14 -0700 | [diff] [blame] | 67 | } |
| 68 | |
Wyatt Hepler | 01fc15b | 2021-06-10 18:15:59 -0700 | [diff] [blame] | 69 | // Move the rest of the member variables. |
Wyatt Hepler | 671946e | 2020-06-09 14:39:33 -0700 | [diff] [blame] | 70 | call_ = std::move(other.call_); |
Wyatt Hepler | cb9d957 | 2020-06-01 11:25:58 -0700 | [diff] [blame] | 71 | response_ = std::move(other.response_); |
Wyatt Hepler | 671946e | 2020-06-09 14:39:33 -0700 | [diff] [blame] | 72 | |
Wyatt Hepler | 01fc15b | 2021-06-10 18:15:59 -0700 | [diff] [blame] | 73 | on_error_ = std::move(other.on_error_); |
| 74 | on_next_ = std::move(other.on_next_); |
Wyatt Hepler | 379b2fc | 2021-06-22 22:54:33 -0700 | [diff] [blame^] | 75 | |
| 76 | #if PW_RPC_CLIENT_STREAM_END_CALLBACK |
Wyatt Hepler | 01fc15b | 2021-06-10 18:15:59 -0700 | [diff] [blame] | 77 | on_client_stream_end_ = std::move(other.on_client_stream_end_); |
Wyatt Hepler | 379b2fc | 2021-06-22 22:54:33 -0700 | [diff] [blame^] | 78 | #endif // PW_RPC_CLIENT_STREAM_END_CALLBACK |
Wyatt Hepler | 01fc15b | 2021-06-10 18:15:59 -0700 | [diff] [blame] | 79 | |
Wyatt Hepler | cb9d957 | 2020-06-01 11:25:58 -0700 | [diff] [blame] | 80 | return *this; |
| 81 | } |
| 82 | |
Wyatt Hepler | 5180fe2 | 2021-06-15 19:32:08 -0700 | [diff] [blame] | 83 | uint32_t Responder::method_id() const { return call_.method().id(); } |
Wyatt Hepler | af83568 | 2020-06-17 11:42:53 -0700 | [diff] [blame] | 84 | |
Wyatt Hepler | 59b37f7 | 2021-06-15 16:23:44 -0700 | [diff] [blame] | 85 | Status Responder::CloseAndSendResponse(std::span<const std::byte> response, |
| 86 | Status status) { |
Wyatt Hepler | 671946e | 2020-06-09 14:39:33 -0700 | [diff] [blame] | 87 | if (!open()) { |
Wyatt Hepler | d08e582 | 2021-02-18 17:53:38 -0800 | [diff] [blame] | 88 | return Status::FailedPrecondition(); |
Wyatt Hepler | cb9d957 | 2020-06-01 11:25:58 -0700 | [diff] [blame] | 89 | } |
Wyatt Hepler | 671946e | 2020-06-09 14:39:33 -0700 | [diff] [blame] | 90 | |
Wyatt Hepler | 59b37f7 | 2021-06-15 16:23:44 -0700 | [diff] [blame] | 91 | // Send a packet indicating that the RPC has terminated. |
| 92 | Status packet_status = |
| 93 | call_.channel().Send(ResponsePacket(call_, response, status)); |
| 94 | |
Wyatt Hepler | 01fc15b | 2021-06-10 18:15:59 -0700 | [diff] [blame] | 95 | // If the Responder implementer or user forgets to release an acquired buffer |
| 96 | // before finishing, release it here. |
Alexei Frolov | b3701c2 | 2020-11-04 11:30:47 -0800 | [diff] [blame] | 97 | if (!response_.empty()) { |
| 98 | ReleasePayloadBuffer(); |
| 99 | } |
| 100 | |
Alexei Frolov | 062ed18 | 2020-09-28 16:23:06 -0700 | [diff] [blame] | 101 | Close(); |
Wyatt Hepler | af83568 | 2020-06-17 11:42:53 -0700 | [diff] [blame] | 102 | |
Wyatt Hepler | 59b37f7 | 2021-06-15 16:23:44 -0700 | [diff] [blame] | 103 | return packet_status; |
Wyatt Hepler | cb9d957 | 2020-06-01 11:25:58 -0700 | [diff] [blame] | 104 | } |
| 105 | |
Wyatt Hepler | 5180fe2 | 2021-06-15 19:32:08 -0700 | [diff] [blame] | 106 | std::span<std::byte> Responder::AcquirePayloadBuffer() { |
Wyatt Hepler | d08e582 | 2021-02-18 17:53:38 -0800 | [diff] [blame] | 107 | PW_DCHECK(open()); |
Wyatt Hepler | cb9d957 | 2020-06-01 11:25:58 -0700 | [diff] [blame] | 108 | |
Alexei Frolov | b3701c2 | 2020-11-04 11:30:47 -0800 | [diff] [blame] | 109 | // Only allow having one active buffer at a time. |
| 110 | if (response_.empty()) { |
| 111 | response_ = call_.channel().AcquireBuffer(); |
| 112 | } |
| 113 | |
Wyatt Hepler | 01fc15b | 2021-06-10 18:15:59 -0700 | [diff] [blame] | 114 | return response_.payload(StreamPacket(call_, {})); |
Wyatt Hepler | cb9d957 | 2020-06-01 11:25:58 -0700 | [diff] [blame] | 115 | } |
| 116 | |
Wyatt Hepler | 5180fe2 | 2021-06-15 19:32:08 -0700 | [diff] [blame] | 117 | Status Responder::ReleasePayloadBuffer(std::span<const std::byte> payload) { |
Wyatt Hepler | d08e582 | 2021-02-18 17:53:38 -0800 | [diff] [blame] | 118 | PW_DCHECK(open()); |
Wyatt Hepler | 01fc15b | 2021-06-10 18:15:59 -0700 | [diff] [blame] | 119 | return call_.channel().Send(response_, StreamPacket(call_, payload)); |
Wyatt Hepler | cb9d957 | 2020-06-01 11:25:58 -0700 | [diff] [blame] | 120 | } |
| 121 | |
Wyatt Hepler | 5180fe2 | 2021-06-15 19:32:08 -0700 | [diff] [blame] | 122 | Status Responder::ReleasePayloadBuffer() { |
Wyatt Hepler | d08e582 | 2021-02-18 17:53:38 -0800 | [diff] [blame] | 123 | PW_DCHECK(open()); |
Alexei Frolov | 909bdfa | 2020-11-03 16:21:47 -0800 | [diff] [blame] | 124 | call_.channel().Release(response_); |
Wyatt Hepler | 1b3da3a | 2021-01-07 13:26:57 -0800 | [diff] [blame] | 125 | return OkStatus(); |
Alexei Frolov | 909bdfa | 2020-11-03 16:21:47 -0800 | [diff] [blame] | 126 | } |
| 127 | |
Wyatt Hepler | 5180fe2 | 2021-06-15 19:32:08 -0700 | [diff] [blame] | 128 | void Responder::Close() { |
Wyatt Hepler | 01fc15b | 2021-06-10 18:15:59 -0700 | [diff] [blame] | 129 | PW_DCHECK(open()); |
Alexei Frolov | 062ed18 | 2020-09-28 16:23:06 -0700 | [diff] [blame] | 130 | |
Wyatt Hepler | 5180fe2 | 2021-06-15 19:32:08 -0700 | [diff] [blame] | 131 | call_.server().RemoveResponder(*this); |
Wyatt Hepler | 01fc15b | 2021-06-10 18:15:59 -0700 | [diff] [blame] | 132 | rpc_state_ = kClosed; |
| 133 | client_stream_state_ = kClientStreamClosed; |
Alexei Frolov | 062ed18 | 2020-09-28 16:23:06 -0700 | [diff] [blame] | 134 | } |
| 135 | |
Wyatt Hepler | cb9d957 | 2020-06-01 11:25:58 -0700 | [diff] [blame] | 136 | } // namespace pw::rpc::internal |