API Reference EN

English · 简体中文

Public API index

This index is checked against the 1.4.0 source. Signatures, parameter types and return values are in the linked API reference. &self does not mean sends are business-acknowledged or concurrent receives are broadcast.

RaknetSocket

Method	API reference
set_idle_maintenance	set_idle_maintenance
mtu	mtu
from (async)	from
connect (async)	connect
connect_with_version (async)	connect_with_version
connect_with_version_and_mtu (async)	connect_with_version_and_mtu
close (async)	close
ping (async)	ping
send (async)	send
send_with_order_channel (async)	send_with_order_channel
send_bytes (async)	send_bytes
send_bytes_with_order_channel (async)	send_bytes_with_order_channel
send_batch (async)	send_batch
send_batch_with_order_channel (async)	send_batch_with_order_channel
send_bytes_batch (async)	send_bytes_batch
send_bytes_batch_with_order_channel (async)	send_bytes_batch_with_order_channel
flush (async)	flush
recv (async)	recv
recv_bytes (async)	recv_bytes
recv_batch (async)	recv_batch
recv_bytes_batch (async)	recv_bytes_batch
peer_addr	peer_addr
local_addr	local_addr
raknet_version	raknet_version
set_loss_rate	set_loss_rate
set_send_options (async)	set_send_options
send_options (async)	send_options
set_recovery_options (async)	set_recovery_options
recovery_options (async)	recovery_options

RaknetListener

Method	API reference
bind (async)	bind
bind_with_maximum_mtu (async)	bind_with_maximum_mtu
bind_with_socket_shards (async)	bind_with_socket_shards
bind_with_receive_buffer_size (async)	bind_with_receive_buffer_size
with_accept_backlog	with_accept_backlog
with_idle_maintenance	with_idle_maintenance
with_receive_batching	with_receive_batching
from_std (async)	from_std
listen (async)	listen
accept (async)	accept
get_guid	get_guid
set_motd (async)	set_motd
get_motd (async)	get_motd
local_addr	local_addr
close (async)	close
set_full_motd (async)	set_full_motd
get_peer_raknet_version (async)	get_peer_raknet_version

blocking::RaknetRuntime

Requires blocking.

Method	API reference
new	new
with_worker_threads	with_worker_threads
connect	connect
connect_timeout	connect_timeout
connect_with_version	connect_with_version
connect_with_version_and_mtu	connect_with_version_and_mtu
bind	bind
bind_with_maximum_mtu	bind_with_maximum_mtu
bind_with_receive_buffer_size	bind_with_receive_buffer_size
bind_with_socket_shards	bind_with_socket_shards
from_std	from_std
ping_timeout	ping_timeout

blocking::RaknetSocket

Requires blocking.

Method	API reference
send	send
send_timeout	send_timeout
send_with_order_channel	send_with_order_channel
send_bytes	send_bytes
send_bytes_timeout	send_bytes_timeout
send_bytes_with_order_channel	send_bytes_with_order_channel
send_batch	send_batch
send_batch_timeout	send_batch_timeout
send_batch_with_order_channel	send_batch_with_order_channel
send_bytes_batch	send_bytes_batch
send_bytes_batch_with_order_channel	send_bytes_batch_with_order_channel
recv	recv
recv_timeout	recv_timeout
recv_bytes	recv_bytes
recv_bytes_timeout	recv_bytes_timeout
recv_batch	recv_batch
recv_batch_timeout	recv_batch_timeout
recv_bytes_batch	recv_bytes_batch
flush	flush
flush_timeout	flush_timeout
close	close
peer_addr	peer_addr
local_addr	local_addr
raknet_version	raknet_version
mtu	mtu
set_idle_maintenance	set_idle_maintenance
set_send_options	set_send_options
send_options	send_options
set_recovery_options	set_recovery_options
recovery_options	recovery_options

blocking::RaknetListener

Requires blocking.

Method	API reference
with_accept_backlog	with_accept_backlog
with_idle_maintenance	with_idle_maintenance
with_receive_batching	with_receive_batching
listen	listen
accept	accept
accept_timeout	accept_timeout
close	close
local_addr	local_addr
get_guid	get_guid
set_full_motd	set_full_motd
get_motd	get_motd
get_peer_raknet_version	get_peer_raknet_version

SendOptions

Requires send-policy.

Method	API reference
with_in_flight_limits	with_in_flight_limits
with_queue_budgets	with_queue_budgets
with_flush_budget	with_flush_budget
in_flight_frames	in_flight_frames
in_flight_bytes	in_flight_bytes
reliable_queue_bytes	reliable_queue_bytes
unreliable_queue_bytes	unreliable_queue_bytes
flush_bytes	flush_bytes

Exports and availability

• Reliability: five modes; see mode selection.
• Bytes: re-exported immutable bytes buffer, used by owned payload APIs.
• RecoveryOptions: public fields deadline_driven, tail_probe_min_delay, reset_backoff_on_progress; requires recovery-policy.
• SendOptions and SendOptionsError: require send-policy.
• error::{RaknetError, Result} and blocking::{Error, Result}: separate error types.
• enable_raknet_log(u8) and exported raknet_log_debug!, raknet_log_error!, raknet_log_info! macros: process logging controls.
• bind_with_socket_shards and with_receive_batching: Linux-only.
• Socket policy methods require their respective features; blocking wrappers require blocking as well.
• RaknetSocket::from is a low-level constructor for an already negotiated/dispatcher-managed connection. It is not a general replacement for connect/accept and does not provide Sans-I/O.
• The blocking wrapper intentionally does not mirror every async helper, such as set_loss_rate or the structured MOTD setter. Use the listed methods, not inferred wrapper names.

Configuration · Errors · Source