• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 // Copyright 2020 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_assert/assert.h"
19 #include "pw_bytes/span.h"
20 #include "pw_rpc/channel.h"
21 #include "pw_rpc/internal/lock.h"
22 #include "pw_rpc/internal/packet.h"
23 #include "pw_status/status.h"
24 
25 namespace pw::rpc::internal {
26 
27 // Returns a portion of the encoding buffer that may be used to encode an
28 // outgoing payload.
29 ByteSpan GetPayloadBuffer() PW_EXCLUSIVE_LOCKS_REQUIRED(rpc_lock());
30 
31 class Channel : public rpc::Channel {
32  public:
33   Channel() = delete;
34 
Channel(uint32_t id,ChannelOutput * output)35   constexpr Channel(uint32_t id, ChannelOutput* output)
36       : rpc::Channel(id, output) {}
37 
38   // Allow closing a channel for internal API users.
39   using rpc::Channel::Close;
40 
41   // Allow setting the channel ID for tests.
42   using rpc::Channel::set_channel_id;
43 
44   Status Send(const Packet& packet) PW_EXCLUSIVE_LOCKS_REQUIRED(rpc_lock());
45 };
46 
47 }  // namespace pw::rpc::internal
48