blob: e6dce02699b49804472c3702ac6bb58692797bf1 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
|
// Copyright 2022 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 <cstdint>
#include "pw_rpc/internal/packet.h"
#include "pw_rpc/internal/packet.pwpb.h"
#include "pw_rpc/method_id.h"
#include "pw_rpc/service_id.h"
#include "pw_span/span.h"
#include "pw_status/status_with_size.h"
namespace pw::rpc {
// Metadata about a `pw_rpc` packet.
//
// For now, this metadata structure only includes a limited set of information
// about the contents of a packet, but it may be extended in the future.
class PacketMeta {
public:
// Parses the metadata from a serialized packet.
static Result<PacketMeta> FromBuffer(ConstByteSpan data);
constexpr uint32_t channel_id() const { return channel_id_; }
constexpr ServiceId service_id() const { return service_id_; }
constexpr MethodId method_id() const { return method_id_; }
constexpr bool destination_is_client() const {
return destination_ == internal::Packet::kClient;
}
constexpr bool destination_is_server() const {
return destination_ == internal::Packet::kServer;
}
constexpr bool type_is_client_error() const {
return type_ == internal::pwpb::PacketType::CLIENT_ERROR;
}
constexpr bool type_is_server_error() const {
return type_ == internal::pwpb::PacketType::SERVER_ERROR;
}
// Note: this `payload` is only valid so long as the original `data` buffer
// passed to `PacketMeta::FromBuffer` remains valid.
constexpr ConstByteSpan payload() const { return payload_; }
private:
constexpr explicit PacketMeta(const internal::Packet packet)
: channel_id_(packet.channel_id()),
service_id_(internal::WrapServiceId(packet.service_id())),
method_id_(internal::WrapMethodId(packet.method_id())),
destination_(packet.destination()),
type_(packet.type()),
payload_(packet.payload()) {}
uint32_t channel_id_;
ServiceId service_id_;
MethodId method_id_;
internal::Packet::Destination destination_;
internal::pwpb::PacketType type_;
ConstByteSpan payload_;
};
} // namespace pw::rpc
|
