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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
use le_stream::FromLeStream;
use crate::ember::NodeId;
use crate::ember::aps::Frame;
use crate::ember::message::Incoming;
use crate::frame::Parameter;
use crate::types::ByteSizedVec;
const ID: u16 = 0x0045;
/// A callback indicating a message has been received.
#[derive(Clone, Debug, Eq, PartialEq, Hash, FromLeStream)]
pub struct Handler {
pub(crate) typ: u8,
pub(crate) aps_frame: Frame,
pub(crate) last_hop_lqi: u8,
pub(crate) last_hop_rssi: i8,
pub(crate) sender: NodeId,
pub(crate) binding_index: u8,
pub(crate) address_index: u8,
pub(crate) message: ByteSizedVec<u8>,
// Some incoming messages have a trailing byte that is not part of the message.
pub(crate) unknown: Option<u8>,
}
impl Handler {
/// The type of the incoming message.
///
/// One of the following:
///
/// - [`Incoming::Unicast`]
/// - [`Incoming::UnicastReply`]
/// - [`Incoming::Multicast`]
/// - [`Incoming::MulticastLoopback`]
/// - [`Incoming::Broadcast`]
/// - [`Incoming::BroadcastLoopback`]
///
/// # Errors
///
/// Returns an error if the value is not a valid incoming message type.
pub fn typ(&self) -> Result<Incoming, u8> {
Incoming::try_from(self.typ)
}
/// The APS frame from the incoming message.
#[must_use]
pub const fn aps_frame(&self) -> &Frame {
&self.aps_frame
}
/// The link quality from the node that last relayed the message.
#[must_use]
pub const fn last_hop_lqi(&self) -> u8 {
self.last_hop_lqi
}
/// The energy level (in units of dBm) observed during the reception.
#[must_use]
pub const fn last_hop_rssi(&self) -> i8 {
self.last_hop_rssi
}
/// The sender of the message.
#[must_use]
pub const fn sender(&self) -> NodeId {
self.sender
}
/// The index of a binding that matches the message or 0xFF if there is no matching binding.
#[must_use]
pub const fn binding_index(&self) -> u8 {
self.binding_index
}
/// The index of the entry in the address table that matches the sender
/// of the message or 0xFF if there is no matching entry.
#[must_use]
pub const fn address_index(&self) -> u8 {
self.address_index
}
/// The incoming message.
#[must_use]
pub fn message(&self) -> &[u8] {
self.message.as_ref()
}
/// Consumes the handler and returns the incoming message.
#[must_use]
pub fn into_message(self) -> ByteSizedVec<u8> {
self.message
}
}
impl Parameter for Handler {
const ID: u16 = ID;
}