Struct uflow::Peer

pub struct Peer { /* private fields */ }

An object representing a connection to a remote host.

Connection States

Implementations

impl Peer

pub fn send(&mut self, data: Box<[u8]>, channel_id: usize, mode: SendMode)

Enqueues a packet for delivery to the remote host. The packet will be sent on the given channel according to the specified mode.

Panics

This function will panic if channel_id does not refer to a valid channel, or if data.len() exceeds the maximum packet size.

pub fn poll_events(&mut self) -> impl Iterator<Item = Event>

Delivers all available events for this connection. See Event for a list of possible event types.

Note 1: All events are considered delivered even if the iterator is not consumed until the end.

Note 2: Packets that have been received will not be acknowledged until this function is called. The number of packets that may be queued prior to being delivered is limited by a maximum transfer window, and by the maximum receive allocation.

pub fn disconnect(&self)

Terminates the connection, notifying the remote host. If currently connected, all pending packets will be sent prior to disconnecting.

A Disconnect event will be generated if a connection was previously established.

pub fn disconnect_now(&self)

Immediately terminates the connection, without notifying the remote host.

A Disconnect event will be generated if a connection was previously established.

pub fn address(&self) -> SocketAddr

Returns the address of the remote host.

pub fn rtt_s(&self) -> Option<f64>

Returns the current round-trip time estimate (RTT), in seconds.

If an RTT estimate has not yet been computed, None is returned instead.

pub fn is_disconnected(&self) -> bool

Returns true if the connection has been terminated or timed out.