third_party/pigweed/repo/pw_router/public/pw_router/egress.h

   1 // Copyright 2021 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 #pragma once
  15
  16 #include <span>
  17
  18 #include "pw_bytes/span.h"
  19 #include "pw_status/status.h"
  20
  21 namespace pw::router {
  22
  23 // Data egress for a router to send packets over some transport system.
  24 class Egress {
  25  public:
  26   virtual ~Egress() = default;
  27
  28   // Sends a complete packet/frame over the transport. Returns OK on success, or
  29   // an error status on failure.
  30   //
  31   // TODO(frolv): Document possible return values.
  32   virtual Status SendPacket(ConstByteSpan packet) = 0;
  33 };
  34
  35 }  // namespace pw::router