Expand description
An asynchronous implementation of the RakNet transport protocol in Rust.
RakNet provides reliable and ordered delivery modes over UDP and is used by Minecraft Bedrock Edition. This library implements the connection handshake, packet reliability, fragmentation, and listener/client APIs. It also exposes a TCP forwarder for NetherNet signaling; gameplay traffic still uses WebRTC.
The library requires the Tokio 1.x asynchronous runtime.
§Features
- Asynchronous client and server APIs
- Five RakNet reliability modes
- Selective retransmission and fast acknowledgements
- IPv4 and IPv6 socket addresses
- NetherNet TCP signaling forwarding
§Getting started
[dependencies]
rust-raknet = "0.14"§Reliability modes
- Unreliable
- Unreliable sequenced
- Reliable
- Reliable ordered
- Reliable sequenced
This project is not affiliated with Jenkins Software LLC or RakNet. See the RakNet protocol reference.
Modules§
Macros§
- raknet_
log_ debug - Print a debug log when debug logging is enabled.
- raknet_
log_ error - Print an error log when error logging is enabled.
- raknet_
log_ info - Print an info log when info logging is enabled.
Structs§
- Nether
NetProxy - Forwards NetherNet’s TCP signaling connections to a NetherNet-capable server.
- Raknet
Listener - A RakNet UDP server that accepts incoming connections.
- Raknet
Socket - A RakNet connection backed by a UDP socket.
Enums§
- Reliability
- Delivery and ordering guarantees for a RakNet frame.
Functions§
- enable_
raknet_ log - Sets the log categories to print.