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