blob: 47c6858559bdf00138f1a5512e4431f23e4d7dba [file] [log] [blame]
// Copyright 2020 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
// 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 <cstddef>
#include <span>
#include <utility>
#include "pw_containers/intrusive_list.h"
#include "pw_rpc/internal/call.h"
#include "pw_rpc/internal/channel.h"
namespace pw::rpc::internal {
class Method;
class Packet;
// Internal ServerWriter base class. ServerWriters are used to stream responses.
// Implementations must provide a derived class that provides the interface for
// sending responses.
class BaseServerWriter : public IntrusiveList<BaseServerWriter>::Item {
BaseServerWriter(ServerCall& call);
BaseServerWriter(const BaseServerWriter&) = delete;
BaseServerWriter(BaseServerWriter&& other) { *this = std::move(other); }
~BaseServerWriter() { Finish(); }
BaseServerWriter& operator=(const BaseServerWriter&) = delete;
BaseServerWriter& operator=(BaseServerWriter&& other);
// True if the ServerWriter is active and ready to send responses.
bool open() const { return state_ == kOpen; }
// Closes the ServerWriter, if it is open.
void Finish();
constexpr BaseServerWriter() : state_{kClosed} {}
const Method& method() const { return call_.method(); }
std::span<std::byte> AcquirePayloadBuffer();
Status ReleasePayloadBuffer(std::span<const std::byte> payload);
Packet packet(std::span<const std::byte> payload = {}) const;
ServerCall call_;
Channel::OutputBuffer response_;
enum { kClosed, kOpen } state_;
} // namespace pw::rpc::internal