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