diff options
Diffstat (limited to 'pw_router/public/pw_router/egress.h')
-rw-r--r-- | pw_router/public/pw_router/egress.h | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/pw_router/public/pw_router/egress.h b/pw_router/public/pw_router/egress.h new file mode 100644 index 000000000..09097e02b --- /dev/null +++ b/pw_router/public/pw_router/egress.h @@ -0,0 +1,35 @@ +// 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 +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// 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 <span> + +#include "pw_bytes/span.h" +#include "pw_status/status.h" + +namespace pw::router { + +// Data egress for a router to send packets over some transport system. +class Egress { + public: + 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) = 0; +}; + +} // namespace pw::router |