Struct grubbnet::Server

pub struct Server { /* fields omitted */ }

Methods

impl Server

pub fn host(ip: &str, port: u16, connection_limit: usize) -> Result<Server>

Begin hosting a TCP server.

pub fn num_connections(&self) -> usize

Get the current number of connections.

pub fn connection_limit(&self) -> usize

Get the maximum number of connections allowed.

pub fn drain_incoming_packets(&mut self) -> Vec<(Token, Packet)>

Drain any incoming packets and return them.

pub fn kick(&mut self, connection_token: Token) -> Result<()>

Kick a connection from the server.

pub fn send(&mut self, recipient: PacketRecipient, packet: impl PacketBody)

Send a packet. This function will box the packet, then queue it to be sent on the next server tick.

pub fn send_boxed(
    &mut self,
    recipient: PacketRecipient,
    packet_boxed: Box<dyn PacketBody>
)

Send a boxed packet. Similar to send, but this is moreuseful when you have a boxed packet already and don't want to cast it to a concrete type before sending it.

pub fn tick(&mut self) -> Vec<ServerEvent>

Runs a network tick, which sends/receives packets based on socket readiness, as well as accepts new connections.