Struct enet::Host

pub struct Host<T> { /* fields omitted */ }

A Host represents one endpoint of an ENet connection. Created through Enet.

This type provides functionality such as connection establishment and packet transmission.

Methods

impl<T> Host<T>

pub fn flush(&mut self)

Sends any queued packets on the host specified to its designated peers.

This function need only be used in circumstances where one wishes to send queued packets earlier than in a call to Host::service().

pub fn set_bandwith_limits(
    &mut self,
    incoming_bandwith: BandwidthLimit,
    outgoing_bandwidth: BandwidthLimit
)

Sets the bandwith limits for this Host.

pub fn set_channel_limit(&mut self, max_channel_count: ChannelLimit)

Sets the maximum allowed channels of future connections.

pub fn channel_limit(&self) -> ChannelLimit

Returns the limit of channels per connected peer for this Host.

pub fn incoming_bandwidth(&self) -> u32

Returns the downstream bandwidth of this Host in bytes/second.

pub fn outgoing_bandwidth(&self) -> u32

Returns the upstream bandwidth of this Host in bytes/second.

pub fn address(&self) -> Address

Returns the internet address of this Host.

pub fn peer_count(&self) -> usize

Returns the number of peers allocated for this Host.

pub fn peers(&mut self) -> impl Iterator<Item = Peer<T>>

Returns an iterator over all peers connected to this Host.

pub fn service(&mut self, timeout_ms: u32) -> Result<Option<Event<T>>, Error>

Maintains this host and delivers an event if available.

This should be called regularly for ENet to work properly with good performance.

pub fn check_events(&mut self) -> Result<Option<Event<T>>, Error>

Checks for any queued events on this Host and dispatches one if available

pub fn connect(
    &mut self,
    address: &Address,
    channel_count: usize,
    user_data: u32
) -> Result<Peer<T>, Error>

Initiates a connection to a foreign host.

The connection will not be done until a Event::Connected for this peer was received.

channel_count specifies how many channels to allocate for this peer. user_data is a user-specified value that can be chosen arbitrarily.

Trait Implementations

impl<T> Drop for Host<T>

fn drop(&mut self)

Call the corresponding ENet cleanup-function(s).