Struct Listener 

pub struct Listener { /* private fields */ }

High-level listener that accepts inbound RakNet peers as Connection objects.

Implementations

impl Listener

pub async fn bind(bind_addr: SocketAddr) -> Result<Self, ServerError>

Creates a listener bound to bind_addr with default configs.

pub fn set_pong_data(&mut self, data: impl Into<String>)

Sets pong/advertisement payload returned during offline ping.

pub fn pong_data(&self) -> &str

Returns pong/advertisement payload.

pub fn set_accept_queue_capacity(&mut self, capacity: usize)

Sets incoming connection queue capacity.

pub fn set_inbound_queue_capacity(&mut self, capacity: usize)

Sets per-connection inbound packet queue capacity.

pub fn set_command_queue_capacity(&mut self, capacity: usize)

Sets command channel capacity used by accepted Connections.

pub fn set_shard_count(&mut self, shard_count: usize)

Sets shard count (minimum 1).

pub fn bind_addr(&self) -> SocketAddr

Returns configured bind address.

pub fn metadata(&self) -> ListenerMetadata

Returns listener metadata snapshot.

pub fn is_started(&self) -> bool

Returns true if runtime is started.

pub async fn start(&mut self) -> Result<(), ServerError>

Starts listener runtime.

pub async fn stop(&mut self) -> Result<(), ServerError>

Stops listener runtime and disconnects active peers.

pub async fn accept(&mut self) -> Result<Connection, ServerError>

Accepts next inbound connection.

pub fn incoming(&mut self) -> Result<Incoming<'_>, ServerError>

Returns Incoming helper for stream-style accept loop.

Trait Implementations

impl Drop for Listener

fn drop(&mut self)

Executes the destructor for this type.