raknet-rust 0.2.0

Asynchronous, high-performance RakNet transport library for Rust.
Documentation
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
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
use std::io;
use std::net::SocketAddr;
use std::time::{Duration, Instant};

use bytes::{Bytes, BytesMut};
use raknet_rust::client::{
    ClientDisconnectReason, ClientSendOptions, OfflineRejectionReason, RaknetClient,
    RaknetClientConfig, RaknetClientError, RaknetClientEvent, ReconnectPolicy,
};
use raknet_rust::low_level::protocol::connected::{
    ConnectedControlPacket, DisconnectionNotification,
};
use raknet_rust::low_level::transport::EventOverflowPolicy;
use raknet_rust::server::{PeerId, RaknetServer, RaknetServerEvent};
use tokio::time::timeout;

fn allocate_loopback_bind_addr() -> SocketAddr {
    let socket = std::net::UdpSocket::bind(SocketAddr::from(([127, 0, 0, 1], 0)))
        .expect("ephemeral loopback bind must succeed");
    socket
        .local_addr()
        .expect("ephemeral local addr must be available")
}

fn encode_control(packet: ConnectedControlPacket) -> Bytes {
    let mut out = BytesMut::new();
    packet
        .encode(&mut out)
        .expect("control packet encoding should succeed");
    out.freeze()
}

async fn start_server(bind_addr: SocketAddr) -> io::Result<RaknetServer> {
    let mut builder = RaknetServer::builder().bind_addr(bind_addr).shard_count(1);

    {
        let transport = builder.transport_config_mut();
        transport.per_ip_packet_limit = 100_000;
        transport.global_packet_limit = 1_000_000;
    }

    {
        let runtime = builder.runtime_config_mut();
        runtime.event_queue_capacity = 2048;
        runtime.metrics_emit_interval = Duration::from_secs(3600);
        runtime.outbound_tick_interval = Duration::from_millis(5);
        runtime.event_overflow_policy = EventOverflowPolicy::ShedNonCritical;
    }

    builder.start().await
}

async fn start_server_with_protocols(
    bind_addr: SocketAddr,
    supported_protocols: Vec<u8>,
) -> io::Result<RaknetServer> {
    let mut builder = RaknetServer::builder().bind_addr(bind_addr).shard_count(1);
    {
        let transport = builder.transport_config_mut();
        transport.per_ip_packet_limit = 100_000;
        transport.global_packet_limit = 1_000_000;
        transport.supported_protocols = supported_protocols;
    }
    {
        let runtime = builder.runtime_config_mut();
        runtime.event_queue_capacity = 2048;
        runtime.metrics_emit_interval = Duration::from_secs(3600);
        runtime.outbound_tick_interval = Duration::from_millis(5);
        runtime.event_overflow_policy = EventOverflowPolicy::ShedNonCritical;
    }
    builder.start().await
}

async fn next_non_metrics_server_event(server: &mut RaknetServer) -> RaknetServerEvent {
    loop {
        let event = timeout(Duration::from_secs(3), server.next_event())
            .await
            .expect("timed out waiting for server event")
            .expect("server event stream unexpectedly ended");
        if !matches!(
            event,
            RaknetServerEvent::Metrics { .. } | RaknetServerEvent::OfflinePacket { .. }
        ) {
            return event;
        }
    }
}

async fn wait_for_server_peer_connected(server: &mut RaknetServer) -> (PeerId, SocketAddr) {
    let deadline = Instant::now() + Duration::from_secs(3);
    while Instant::now() < deadline {
        if let RaknetServerEvent::PeerConnected {
            peer_id,
            addr,
            client_guid,
            shard_id,
        } = next_non_metrics_server_event(server).await
        {
            assert_eq!(shard_id, 0, "single-shard server must report shard 0");
            assert_ne!(client_guid, 0, "client_guid must be populated");
            return (peer_id, addr);
        }
    }

    panic!("timed out waiting for PeerConnected");
}

async fn wait_for_client_packet(client: &mut RaknetClient) -> Bytes {
    let deadline = Instant::now() + Duration::from_secs(3);
    while Instant::now() < deadline {
        let event = timeout(Duration::from_secs(3), client.next_event())
            .await
            .expect("timed out waiting for client event")
            .expect("client event stream unexpectedly ended");

        match event {
            RaknetClientEvent::Packet { payload, .. } => return payload,
            RaknetClientEvent::DecodeError { error } => {
                panic!("unexpected client decode error: {error}")
            }
            RaknetClientEvent::Disconnected { reason } => {
                panic!("client disconnected unexpectedly: {reason:?}")
            }
            RaknetClientEvent::Connected { .. } | RaknetClientEvent::ReceiptAcked { .. } => {}
        }
    }

    panic!("timed out waiting for client packet");
}

#[tokio::test(flavor = "current_thread")]
async fn client_connects_and_exchanges_packets_with_server() -> io::Result<()> {
    let bind_addr = allocate_loopback_bind_addr();
    let mut server = start_server(bind_addr).await?;
    let mut client = RaknetClient::connect(bind_addr).await?;

    match timeout(Duration::from_secs(3), client.next_event())
        .await
        .expect("timed out waiting for connected event")
        .expect("client event stream unexpectedly ended")
    {
        RaknetClientEvent::Connected { server_addr, mtu } => {
            assert_eq!(server_addr, bind_addr);
            assert!((576..=1400).contains(&mtu));
        }
        other => panic!("expected connected event, got {other:?}"),
    }

    let payload = Bytes::from_static(b"\xFEclient->server");
    client.send(payload.clone()).await?;

    let (peer_id, peer_addr) = wait_for_server_peer_connected(&mut server).await;

    let packet_event = next_non_metrics_server_event(&mut server).await;
    match packet_event {
        RaknetServerEvent::Packet {
            peer_id: got_peer_id,
            addr,
            payload: got_payload,
            ..
        } => {
            assert_eq!(got_peer_id, peer_id);
            assert_eq!(addr, peer_addr);
            assert_eq!(got_payload, payload);
        }
        other => panic!("expected packet event after connect, got {other:?}"),
    }

    let echo = Bytes::from_static(b"\xFEserver->client");
    server.send(peer_id, echo.clone()).await?;

    let client_payload = wait_for_client_packet(&mut client).await;
    assert_eq!(client_payload, echo);

    client.disconnect(None).await?;
    server.shutdown().await
}

#[tokio::test(flavor = "current_thread")]
async fn client_surfaces_remote_disconnection_notification() -> io::Result<()> {
    let bind_addr = allocate_loopback_bind_addr();
    let mut server = start_server(bind_addr).await?;
    let mut client = RaknetClient::connect(bind_addr).await?;

    let _ = timeout(Duration::from_secs(3), client.next_event())
        .await
        .expect("timed out waiting for connected event")
        .expect("client event stream unexpectedly ended");

    client.send(Bytes::from_static(b"\xFEhello")).await?;
    let (peer_id, _) = wait_for_server_peer_connected(&mut server).await;

    let disconnect_payload = encode_control(ConnectedControlPacket::DisconnectionNotification(
        DisconnectionNotification { reason: Some(7) },
    ));
    server.send(peer_id, disconnect_payload).await?;

    let deadline = Instant::now() + Duration::from_secs(3);
    while Instant::now() < deadline {
        let event = timeout(Duration::from_secs(3), client.next_event())
            .await
            .expect("timed out waiting for client disconnect event")
            .expect("client event stream unexpectedly ended");

        match event {
            RaknetClientEvent::Disconnected { reason } => {
                assert_eq!(
                    reason,
                    ClientDisconnectReason::RemoteDisconnectionNotification {
                        reason_code: Some(7)
                    }
                );
                server.shutdown().await?;
                return Ok(());
            }
            RaknetClientEvent::Connected { .. }
            | RaknetClientEvent::Packet { .. }
            | RaknetClientEvent::ReceiptAcked { .. }
            | RaknetClientEvent::DecodeError { .. } => {}
        }
    }

    panic!("timed out waiting for remote disconnect event");
}

#[tokio::test(flavor = "current_thread")]
async fn client_send_with_receipt_emits_receipt_acked_event() -> io::Result<()> {
    let bind_addr = allocate_loopback_bind_addr();
    let mut server = start_server(bind_addr).await?;
    let mut client = RaknetClient::connect(bind_addr).await?;

    let _ = timeout(Duration::from_secs(3), client.next_event())
        .await
        .expect("timed out waiting for connected event")
        .expect("client event stream unexpectedly ended");

    let receipt_id = 0xAA55_AA55_AA55_AA55;
    client
        .send_with_receipt(
            Bytes::from_static(b"\xFEsend-with-receipt"),
            receipt_id,
            ClientSendOptions::default(),
        )
        .await?;

    let _ = wait_for_server_peer_connected(&mut server).await;
    let _ = next_non_metrics_server_event(&mut server).await;

    let deadline = Instant::now() + Duration::from_secs(3);
    while Instant::now() < deadline {
        let event = timeout(Duration::from_secs(3), client.next_event())
            .await
            .expect("timed out waiting for receipt ack event")
            .expect("client event stream unexpectedly ended");

        match event {
            RaknetClientEvent::ReceiptAcked {
                receipt_id: acked_id,
            } => {
                assert_eq!(acked_id, receipt_id);
                client.disconnect(None).await?;
                server.shutdown().await?;
                return Ok(());
            }
            RaknetClientEvent::Disconnected { reason } => {
                panic!("unexpected disconnect before receipt ack: {reason:?}");
            }
            RaknetClientEvent::Connected { .. }
            | RaknetClientEvent::Packet { .. }
            | RaknetClientEvent::DecodeError { .. } => {}
        }
    }

    panic!("timed out waiting for receipt ack event");
}

#[tokio::test(flavor = "current_thread")]
async fn server_send_with_receipt_emits_receipt_acked_event() -> io::Result<()> {
    let bind_addr = allocate_loopback_bind_addr();
    let mut server = start_server(bind_addr).await?;
    let mut client = RaknetClient::connect(bind_addr).await?;

    let _ = timeout(Duration::from_secs(3), client.next_event())
        .await
        .expect("timed out waiting for connected event")
        .expect("client event stream unexpectedly ended");

    let (peer_id, peer_addr) = wait_for_server_peer_connected(&mut server).await;

    let payload = Bytes::from_static(b"\xFEserver-send-with-receipt");
    let receipt_id = 0x55AA_55AA_55AA_55AA;
    server
        .send_with_receipt(peer_id, payload.clone(), receipt_id)
        .await?;

    let client_payload = wait_for_client_packet(&mut client).await;
    assert_eq!(client_payload, payload);

    let deadline = Instant::now() + Duration::from_secs(3);
    while Instant::now() < deadline {
        let remaining = deadline.saturating_duration_since(Instant::now());
        let event = timeout(
            remaining.min(Duration::from_millis(400)),
            server.next_event(),
        )
        .await;
        let Ok(Some(event)) = event else {
            continue;
        };

        match event {
            RaknetServerEvent::Metrics { .. }
            | RaknetServerEvent::Packet { .. }
            | RaknetServerEvent::OfflinePacket { .. } => {}
            RaknetServerEvent::ReceiptAcked {
                peer_id: got_peer_id,
                addr,
                receipt_id: acked_id,
            } => {
                assert_eq!(got_peer_id, peer_id);
                assert_eq!(addr, peer_addr);
                assert_eq!(acked_id, receipt_id);
                client.disconnect(None).await?;
                server.shutdown().await?;
                return Ok(());
            }
            RaknetServerEvent::PeerDisconnected { reason, .. } => {
                panic!("unexpected server-side disconnect before receipt ack: {reason:?}");
            }
            RaknetServerEvent::PeerConnected { .. }
            | RaknetServerEvent::PeerRateLimited { .. }
            | RaknetServerEvent::SessionLimitReached { .. }
            | RaknetServerEvent::ProxyDropped { .. }
            | RaknetServerEvent::DecodeError { .. }
            | RaknetServerEvent::WorkerError { .. }
            | RaknetServerEvent::WorkerStopped { .. } => {}
        }
    }

    panic!("timed out waiting for server-side receipt ack event");
}

#[tokio::test(flavor = "current_thread")]
async fn client_idle_timeout_closes_connection_without_inbound_activity() -> io::Result<()> {
    let bind_addr = allocate_loopback_bind_addr();
    let server = start_server(bind_addr).await?;

    let cfg = RaknetClientConfig {
        session_idle_timeout: Duration::from_millis(120),
        session_keepalive_interval: Duration::from_secs(3600),
        outbound_tick_interval: Duration::from_millis(10),
        ..RaknetClientConfig::default()
    };

    let mut client = RaknetClient::connect_with_config(bind_addr, cfg).await?;
    let _ = timeout(Duration::from_secs(3), client.next_event())
        .await
        .expect("timed out waiting for connected event")
        .expect("client event stream unexpectedly ended");

    let deadline = Instant::now() + Duration::from_secs(3);
    while Instant::now() < deadline {
        let event = timeout(Duration::from_secs(3), client.next_event())
            .await
            .expect("timed out waiting for idle timeout event")
            .expect("client event stream unexpectedly ended");

        if let RaknetClientEvent::Disconnected { reason } = event {
            assert_eq!(reason, ClientDisconnectReason::IdleTimeout);
            server.shutdown().await?;
            return Ok(());
        }
    }

    panic!("timed out waiting for idle timeout disconnect");
}

#[tokio::test(flavor = "current_thread")]
async fn connect_maps_incompatible_protocol_to_explicit_error() -> io::Result<()> {
    let bind_addr = allocate_loopback_bind_addr();
    let server = start_server_with_protocols(bind_addr, vec![10]).await?;

    let result = RaknetClient::connect(bind_addr).await;
    let error = match result {
        Ok(_) => panic!("connect should fail with incompatible protocol"),
        Err(error) => error,
    };

    assert!(matches!(
        error,
        RaknetClientError::OfflineRejected {
            reason: OfflineRejectionReason::IncompatibleProtocolVersion {
                protocol_version: 10,
                ..
            }
        }
    ));

    server.shutdown().await?;
    Ok(())
}

#[tokio::test(flavor = "current_thread")]
async fn connect_with_retry_fast_fails_on_offline_rejection() -> io::Result<()> {
    let bind_addr = allocate_loopback_bind_addr();
    let server = start_server_with_protocols(bind_addr, vec![10]).await?;

    let policy = ReconnectPolicy {
        max_attempts: 5,
        initial_backoff: Duration::from_millis(20),
        max_backoff: Duration::from_millis(40),
        fast_fail_on_offline_rejection: true,
        ..ReconnectPolicy::default()
    };

    let start = Instant::now();
    let result =
        RaknetClient::connect_with_retry(bind_addr, RaknetClientConfig::default(), policy).await;
    let elapsed = start.elapsed();

    let error = match result {
        Ok(_) => panic!("connect_with_retry should fail with incompatible protocol"),
        Err(error) => error,
    };

    assert!(matches!(
        error,
        RaknetClientError::OfflineRejected {
            reason: OfflineRejectionReason::IncompatibleProtocolVersion { .. }
        }
    ));
    assert!(
        elapsed < Duration::from_secs(1),
        "fast-fail should not spend retry backoff budget"
    );

    server.shutdown().await?;
    Ok(())
}