Struct rollo::server::SocketTools

pub struct SocketTools {
    pub socket_addr: SocketAddr,
    pub id: u64,
    // some fields omitted
}

This is supported on crate feature server only.

Send packets, latency, SocketTools etc.

Fields

socket_addr: SocketAddr

id: u64

Implementations

impl SocketTools

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

Send a packet to the session

Examples

use rollo::server::SocketTools;

fn on_message(socket: SocketTools) {
    socket.send(1, None);
}

pub fn send_data(&self, bytes: Bytes)

Send Bytes(Packet) to the session

Examples

use rollo::server::SocketTools;
use rollo::packet::to_bytes;

fn on_message(socket: SocketTools) {
    let bytes = to_bytes(1, None).freeze();
    socket.send_data(bytes);
}

pub fn get_latency(&self) -> i64

get Latency

Examples

use rollo::server::SocketTools;

fn on_message(socket: SocketTools) {
    let latency = socket.get_latency();
}

pub fn send_flatbuffers<F: 'static + Fn(&mut FlatBufferBuilder<'static>) -> Bytes + Send + Sync>(
    &self,
    f: F
)

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

Close the session

Examples

use rollo::server::SocketTools;

fn on_message(socket: SocketTools) {
    if socket.close().is_err() {
        println!("Error when closing the session");
    }
}

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

Close the session with a delay

Examples

use rollo::server::SocketTools;
use std::time::Duration;

fn on_message(socket: SocketTools) {
    if socket.close_with_delay(Duration::from_secs(1)).is_err() {
        println!("Error when closing the session");
    }
}

pub fn is_closed(&self) -> bool

Is connection close ?

Examples

use rollo::server::SocketTools;

fn on_message(socket: SocketTools) {
    if socket.is_closed() {
    // Do something
    }
}

Trait Implementations

impl Clone for SocketTools

fn clone(&self) -> Self

Returns a copy 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 PartialEq<SocketTools> for SocketTools

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Eq for SocketTools