Struct SocketTools 

pub struct SocketTools {
    pub socket_addr: SocketAddr,
    pub id: u64,
    /* private fields */
}

Available on crate feature server only.

A struct for sending packets, measuring latency, and managing the SocketTools object.

Fields

socket_addr: SocketAddr

The socket address.

id: u64

The ID of the SocketTools object.

Implementations

impl SocketTools

pub fn send(&self, cmd: u16, payload: Option<&[u8]>)

Sends a packet to the session.

pub fn send_data(&self, bytes: ContainerBytes)

Sends bytes (Packet) to the session.

pub fn write_data(&self, bytes: ContainerBytes)

Writes bytes (Packet) to the session.

pub fn flush(&self)

Flushes the session.

pub fn get_latency(&self) -> i64

Returns the latency of the connection.

pub fn close(&self) -> Result<()>

Closes the session.

pub fn close_with_delay(&self, delay: Duration) -> Result<()>

Closes the session with a delay.

pub fn is_closed(&self) -> bool

Returns true if the connection is closed.

Trait Implementations

impl Clone for SocketTools

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SocketTools

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for SocketTools

impl PartialEq for SocketTools

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.