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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
//! Network event types for Route protocol monitoring.
//!
//! This module provides the [`NetworkEvent`] enum representing events
//! received from the kernel via RTNetlink multicast groups.
//!
//! # Example
//!
//! ```ignore
//! use nlink::netlink::{Connection, Route, RtnetlinkGroup, NetworkEvent};
//! use tokio_stream::StreamExt;
//!
//! let mut conn = Connection::<Route>::new()?;
//! conn.subscribe(&[RtnetlinkGroup::Link, RtnetlinkGroup::Tc])?;
//!
//! let mut events = conn.events();
//! while let Some(event) = events.next().await {
//! match event? {
//! NetworkEvent::NewLink(link) => {
//! println!("New link: {}", link.name_or("?"));
//! }
//! NetworkEvent::DelLink(link) => {
//! println!("Deleted link: {}", link.name_or("?"));
//! }
//! _ => {}
//! }
//! }
//! ```
use super::{
fdb::FdbEntry,
messages::{AddressMessage, LinkMessage, NeighborMessage, RouteMessage, TcMessage},
};
/// Network events that can be received from the kernel.
///
/// These events are generated when network configuration changes occur.
/// Use [`Connection<Route>::subscribe`](super::Connection::subscribe) to select
/// which event types to receive, then use [`Connection::events`](super::Connection::events)
/// to get a stream of events.
#[derive(Debug, Clone)]
#[non_exhaustive]
pub enum NetworkEvent {
// Link events
/// A new link was created or an existing link changed.
NewLink(LinkMessage),
/// A link was deleted.
DelLink(LinkMessage),
// Address events
/// A new address was added.
NewAddress(AddressMessage),
/// An address was removed.
DelAddress(AddressMessage),
// Route events
/// A new route was added.
NewRoute(RouteMessage),
/// A route was removed.
DelRoute(RouteMessage),
// Neighbor events
/// A new neighbor entry was added.
NewNeighbor(NeighborMessage),
/// A neighbor entry was removed.
DelNeighbor(NeighborMessage),
// FDB (bridge forwarding database) events
/// A new FDB entry was added or learned.
NewFdb(FdbEntry),
/// An FDB entry was removed.
DelFdb(FdbEntry),
// Traffic control events
/// A new qdisc was added or changed.
NewQdisc(TcMessage),
/// A qdisc was deleted.
DelQdisc(TcMessage),
/// A new class was added or changed.
NewClass(TcMessage),
/// A class was deleted.
DelClass(TcMessage),
/// A new filter was added or changed.
NewFilter(TcMessage),
/// A filter was deleted.
DelFilter(TcMessage),
/// A new action was added or changed.
NewAction(TcMessage),
/// An action was deleted.
DelAction(TcMessage),
}
impl NetworkEvent {
/// Returns true if this is a "new" event (add or change).
pub fn is_new(&self) -> bool {
matches!(
self,
NetworkEvent::NewLink(_)
| NetworkEvent::NewAddress(_)
| NetworkEvent::NewRoute(_)
| NetworkEvent::NewNeighbor(_)
| NetworkEvent::NewFdb(_)
| NetworkEvent::NewQdisc(_)
| NetworkEvent::NewClass(_)
| NetworkEvent::NewFilter(_)
| NetworkEvent::NewAction(_)
)
}
/// Returns true if this is a "delete" event.
pub fn is_del(&self) -> bool {
!self.is_new()
}
/// Returns the interface index associated with this event, if any.
pub fn ifindex(&self) -> Option<u32> {
match self {
NetworkEvent::NewLink(m) | NetworkEvent::DelLink(m) => Some(m.ifindex()),
NetworkEvent::NewAddress(m) | NetworkEvent::DelAddress(m) => Some(m.ifindex()),
NetworkEvent::NewNeighbor(m) | NetworkEvent::DelNeighbor(m) => Some(m.ifindex()),
NetworkEvent::NewFdb(m) | NetworkEvent::DelFdb(m) => Some(m.ifindex),
NetworkEvent::NewQdisc(m)
| NetworkEvent::DelQdisc(m)
| NetworkEvent::NewClass(m)
| NetworkEvent::DelClass(m)
| NetworkEvent::NewFilter(m)
| NetworkEvent::DelFilter(m)
| NetworkEvent::NewAction(m)
| NetworkEvent::DelAction(m) => Some(m.ifindex()),
NetworkEvent::NewRoute(_) | NetworkEvent::DelRoute(_) => None,
}
}
/// Returns "new" or "del" based on the event type.
///
/// Useful for display/logging purposes.
pub fn action(&self) -> &'static str {
if self.is_new() { "new" } else { "del" }
}
/// Returns the inner LinkMessage if this is a link event.
pub fn as_link(&self) -> Option<&LinkMessage> {
match self {
NetworkEvent::NewLink(m) | NetworkEvent::DelLink(m) => Some(m),
_ => None,
}
}
/// Consumes self and returns the inner LinkMessage if this is a link event.
pub fn into_link(self) -> Option<LinkMessage> {
match self {
NetworkEvent::NewLink(m) | NetworkEvent::DelLink(m) => Some(m),
_ => None,
}
}
/// Returns the inner AddressMessage if this is an address event.
pub fn as_address(&self) -> Option<&AddressMessage> {
match self {
NetworkEvent::NewAddress(m) | NetworkEvent::DelAddress(m) => Some(m),
_ => None,
}
}
/// Consumes self and returns the inner AddressMessage if this is an address event.
pub fn into_address(self) -> Option<AddressMessage> {
match self {
NetworkEvent::NewAddress(m) | NetworkEvent::DelAddress(m) => Some(m),
_ => None,
}
}
/// Returns the inner RouteMessage if this is a route event.
pub fn as_route(&self) -> Option<&RouteMessage> {
match self {
NetworkEvent::NewRoute(m) | NetworkEvent::DelRoute(m) => Some(m),
_ => None,
}
}
/// Consumes self and returns the inner RouteMessage if this is a route event.
pub fn into_route(self) -> Option<RouteMessage> {
match self {
NetworkEvent::NewRoute(m) | NetworkEvent::DelRoute(m) => Some(m),
_ => None,
}
}
/// Returns the inner NeighborMessage if this is a neighbor event.
pub fn as_neighbor(&self) -> Option<&NeighborMessage> {
match self {
NetworkEvent::NewNeighbor(m) | NetworkEvent::DelNeighbor(m) => Some(m),
_ => None,
}
}
/// Consumes self and returns the inner NeighborMessage if this is a neighbor event.
pub fn into_neighbor(self) -> Option<NeighborMessage> {
match self {
NetworkEvent::NewNeighbor(m) | NetworkEvent::DelNeighbor(m) => Some(m),
_ => None,
}
}
/// Returns the inner FdbEntry if this is an FDB event.
pub fn as_fdb(&self) -> Option<&FdbEntry> {
match self {
NetworkEvent::NewFdb(m) | NetworkEvent::DelFdb(m) => Some(m),
_ => None,
}
}
/// Consumes self and returns the inner FdbEntry if this is an FDB event.
pub fn into_fdb(self) -> Option<FdbEntry> {
match self {
NetworkEvent::NewFdb(m) | NetworkEvent::DelFdb(m) => Some(m),
_ => None,
}
}
/// Returns the inner TcMessage if this is a TC event (qdisc, class, filter, or action).
pub fn as_tc(&self) -> Option<&TcMessage> {
match self {
NetworkEvent::NewQdisc(m)
| NetworkEvent::DelQdisc(m)
| NetworkEvent::NewClass(m)
| NetworkEvent::DelClass(m)
| NetworkEvent::NewFilter(m)
| NetworkEvent::DelFilter(m)
| NetworkEvent::NewAction(m)
| NetworkEvent::DelAction(m) => Some(m),
_ => None,
}
}
/// Consumes self and returns the inner TcMessage if this is a TC event.
pub fn into_tc(self) -> Option<TcMessage> {
match self {
NetworkEvent::NewQdisc(m)
| NetworkEvent::DelQdisc(m)
| NetworkEvent::NewClass(m)
| NetworkEvent::DelClass(m)
| NetworkEvent::NewFilter(m)
| NetworkEvent::DelFilter(m)
| NetworkEvent::NewAction(m)
| NetworkEvent::DelAction(m) => Some(m),
_ => None,
}
}
}