xref: /aosp_15_r20/external/pigweed/pw_router/public/pw_router/egress.h (revision 61c4878ac05f98d0ceed94b57d316916de578985)
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 <optional>
17 
18 #include "pw_bytes/span.h"
19 #include "pw_router/packet_parser.h"
20 #include "pw_span/span.h"
21 #include "pw_status/status.h"
22 
23 namespace pw::router {
24 
25 // Data egress for a router to send packets over some transport system.
26 class Egress {
27  public:
28   virtual ~Egress() = default;
29 
30   // Sends a complete packet/frame over the transport. Returns OK on success, or
31   // an error status on failure. Invoked with the packet data and the parser
32   // from the RoutePacket() call.
33   //
34   // TODO(frolv): Document possible return values.
35   virtual Status SendPacket(ConstByteSpan packet,
36                             const PacketParser& parser) = 0;
37 };
38 
39 }  // namespace pw::router
40