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 | |
| 15 | #include "pw_rpc/internal/base_server_writer.h" |
| 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 { |
| 23 | |
Wyatt Hepler | 5180fe2 | 2021-06-15 19:32:08 -0700 | [diff] [blame^] | 24 | Responder::Responder(ServerCall& call) : call_(call), state_(kOpen) { |
| 25 | call_.server().RegisterResponder(*this); |
Wyatt Hepler | 60fd70f | 2020-06-17 09:04:25 -0700 | [diff] [blame] | 26 | } |
| 27 | |
Wyatt Hepler | 5180fe2 | 2021-06-15 19:32:08 -0700 | [diff] [blame^] | 28 | Responder& Responder::operator=(Responder&& other) { |
Wyatt Hepler | b7643d7 | 2020-07-10 10:33:14 -0700 | [diff] [blame] | 29 | Finish(); |
| 30 | |
| 31 | state_ = other.state_; |
| 32 | |
| 33 | if (other.open()) { |
Wyatt Hepler | 5180fe2 | 2021-06-15 19:32:08 -0700 | [diff] [blame^] | 34 | other.call_.server().RemoveResponder(other); |
Wyatt Hepler | b7643d7 | 2020-07-10 10:33:14 -0700 | [diff] [blame] | 35 | other.state_ = kClosed; |
| 36 | |
Wyatt Hepler | 5180fe2 | 2021-06-15 19:32:08 -0700 | [diff] [blame^] | 37 | other.call_.server().RegisterResponder(*this); |
Wyatt Hepler | b7643d7 | 2020-07-10 10:33:14 -0700 | [diff] [blame] | 38 | } |
| 39 | |
Wyatt Hepler | 671946e | 2020-06-09 14:39:33 -0700 | [diff] [blame] | 40 | call_ = std::move(other.call_); |
Wyatt Hepler | cb9d957 | 2020-06-01 11:25:58 -0700 | [diff] [blame] | 41 | response_ = std::move(other.response_); |
Wyatt Hepler | 671946e | 2020-06-09 14:39:33 -0700 | [diff] [blame] | 42 | |
Wyatt Hepler | cb9d957 | 2020-06-01 11:25:58 -0700 | [diff] [blame] | 43 | return *this; |
| 44 | } |
| 45 | |
Wyatt Hepler | 5180fe2 | 2021-06-15 19:32:08 -0700 | [diff] [blame^] | 46 | uint32_t Responder::method_id() const { return call_.method().id(); } |
Wyatt Hepler | af83568 | 2020-06-17 11:42:53 -0700 | [diff] [blame] | 47 | |
Wyatt Hepler | 5180fe2 | 2021-06-15 19:32:08 -0700 | [diff] [blame^] | 48 | Status Responder::Finish(Status status) { |
Wyatt Hepler | 671946e | 2020-06-09 14:39:33 -0700 | [diff] [blame] | 49 | if (!open()) { |
Wyatt Hepler | d08e582 | 2021-02-18 17:53:38 -0800 | [diff] [blame] | 50 | return Status::FailedPrecondition(); |
Wyatt Hepler | cb9d957 | 2020-06-01 11:25:58 -0700 | [diff] [blame] | 51 | } |
Wyatt Hepler | 671946e | 2020-06-09 14:39:33 -0700 | [diff] [blame] | 52 | |
Wyatt Hepler | 5180fe2 | 2021-06-15 19:32:08 -0700 | [diff] [blame^] | 53 | // If the Responder implementer or user forgets to release an acquired |
Alexei Frolov | b3701c2 | 2020-11-04 11:30:47 -0800 | [diff] [blame] | 54 | // buffer before finishing, release it here. |
| 55 | if (!response_.empty()) { |
| 56 | ReleasePayloadBuffer(); |
| 57 | } |
| 58 | |
Alexei Frolov | 062ed18 | 2020-09-28 16:23:06 -0700 | [diff] [blame] | 59 | Close(); |
Wyatt Hepler | af83568 | 2020-06-17 11:42:53 -0700 | [diff] [blame] | 60 | |
Wyatt Hepler | 712d367 | 2020-07-13 15:52:11 -0700 | [diff] [blame] | 61 | // Send a control packet indicating that the stream (and RPC) has terminated. |
Wyatt Hepler | d08e582 | 2021-02-18 17:53:38 -0800 | [diff] [blame] | 62 | return call_.channel().Send(Packet(PacketType::SERVER_STREAM_END, |
| 63 | call_.channel().id(), |
| 64 | call_.service().id(), |
| 65 | method().id(), |
| 66 | {}, |
| 67 | status)); |
Wyatt Hepler | cb9d957 | 2020-06-01 11:25:58 -0700 | [diff] [blame] | 68 | } |
| 69 | |
Wyatt Hepler | 5180fe2 | 2021-06-15 19:32:08 -0700 | [diff] [blame^] | 70 | std::span<std::byte> Responder::AcquirePayloadBuffer() { |
Wyatt Hepler | d08e582 | 2021-02-18 17:53:38 -0800 | [diff] [blame] | 71 | PW_DCHECK(open()); |
Wyatt Hepler | cb9d957 | 2020-06-01 11:25:58 -0700 | [diff] [blame] | 72 | |
Alexei Frolov | b3701c2 | 2020-11-04 11:30:47 -0800 | [diff] [blame] | 73 | // Only allow having one active buffer at a time. |
| 74 | if (response_.empty()) { |
| 75 | response_ = call_.channel().AcquireBuffer(); |
| 76 | } |
| 77 | |
Wyatt Hepler | 0f26235 | 2020-07-29 09:51:27 -0700 | [diff] [blame] | 78 | return response_.payload(ResponsePacket()); |
Wyatt Hepler | cb9d957 | 2020-06-01 11:25:58 -0700 | [diff] [blame] | 79 | } |
| 80 | |
Wyatt Hepler | 5180fe2 | 2021-06-15 19:32:08 -0700 | [diff] [blame^] | 81 | Status Responder::ReleasePayloadBuffer(std::span<const std::byte> payload) { |
Wyatt Hepler | d08e582 | 2021-02-18 17:53:38 -0800 | [diff] [blame] | 82 | PW_DCHECK(open()); |
Wyatt Hepler | 0f26235 | 2020-07-29 09:51:27 -0700 | [diff] [blame] | 83 | return call_.channel().Send(response_, ResponsePacket(payload)); |
Wyatt Hepler | cb9d957 | 2020-06-01 11:25:58 -0700 | [diff] [blame] | 84 | } |
| 85 | |
Wyatt Hepler | 5180fe2 | 2021-06-15 19:32:08 -0700 | [diff] [blame^] | 86 | Status Responder::ReleasePayloadBuffer() { |
Wyatt Hepler | d08e582 | 2021-02-18 17:53:38 -0800 | [diff] [blame] | 87 | PW_DCHECK(open()); |
Alexei Frolov | 909bdfa | 2020-11-03 16:21:47 -0800 | [diff] [blame] | 88 | call_.channel().Release(response_); |
Wyatt Hepler | 1b3da3a | 2021-01-07 13:26:57 -0800 | [diff] [blame] | 89 | return OkStatus(); |
Alexei Frolov | 909bdfa | 2020-11-03 16:21:47 -0800 | [diff] [blame] | 90 | } |
| 91 | |
Wyatt Hepler | 5180fe2 | 2021-06-15 19:32:08 -0700 | [diff] [blame^] | 92 | void Responder::Close() { |
Alexei Frolov | 062ed18 | 2020-09-28 16:23:06 -0700 | [diff] [blame] | 93 | if (!open()) { |
| 94 | return; |
| 95 | } |
| 96 | |
Wyatt Hepler | 5180fe2 | 2021-06-15 19:32:08 -0700 | [diff] [blame^] | 97 | call_.server().RemoveResponder(*this); |
Alexei Frolov | 062ed18 | 2020-09-28 16:23:06 -0700 | [diff] [blame] | 98 | state_ = kClosed; |
| 99 | } |
| 100 | |
Wyatt Hepler | 5180fe2 | 2021-06-15 19:32:08 -0700 | [diff] [blame^] | 101 | Packet Responder::ResponsePacket(std::span<const std::byte> payload) const { |
Wyatt Hepler | 0f26235 | 2020-07-29 09:51:27 -0700 | [diff] [blame] | 102 | return Packet(PacketType::RESPONSE, |
Wyatt Hepler | 671946e | 2020-06-09 14:39:33 -0700 | [diff] [blame] | 103 | call_.channel().id(), |
| 104 | call_.service().id(), |
| 105 | method().id(), |
| 106 | payload); |
Wyatt Hepler | cb9d957 | 2020-06-01 11:25:58 -0700 | [diff] [blame] | 107 | } |
| 108 | |
| 109 | } // namespace pw::rpc::internal |