blob: 4c4972b66dacd80463455a0d6fba2f949d2c5376 [file] [log] [blame]
// Copyright 2021 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 <optional>
#include <span>
#include "pw_bytes/span.h"
#include "pw_status/status.h"
namespace pw::router {
// Data extracted from a packet which is forwarded to the egress.
struct PacketMetadata {
// Project-defined priority of the packet.
std::optional<uint32_t> priority;
// Data egress for a router to send packets over some transport system.
class Egress {
virtual ~Egress() = default;
// Sends a complete packet/frame over the transport. Returns OK on success, or
// an error status on failure.
// TODO(frolv): Document possible return values.
virtual Status SendPacket(ConstByteSpan packet,
const PacketMetadata& metadata) = 0;
} // namespace pw::router