Struct carrier_pigeon::Server

pub struct Server { /* private fields */ }

A server.

Listens on a address and port, allowing for clients to connect. Newly connected clients will be given a client ID (CId) starting at 1 that is unique for the session.

This will manage multiple connections to clients. Each connection will have a TCP and UDP connection on the same address and port.

Implementations

impl Server

pub fn new(
    listen_addr: SocketAddr,
    parts: MsgTableParts,
    config: Config
) -> Result<Self>

Creates a new Server.

Creates a new Server listening on the address listen_addr.

pub fn config(&self) -> &Config

Gets the config of the server.

pub fn disconnect<T: Any + Send + Sync>(
    &mut self,
    discon_msg: &T,
    cid: CId
) -> Result<()>

Disconnects from the given cid. You should always disconnect all clients before dropping the server to let the clients know that you intentionally disconnected. The discon_msg allows you to give a reason for the disconnect.

pub fn handle_new_con<C: Any + Send + Sync, R: Any + Send + Sync>(
    &mut self,
    hook: impl FnMut(CId, C) -> (bool, R)
) -> bool

Handles all available new connection attempts in a loop, calling the given hook for each.

The hook function should return (should_accept, response_msg).

Types C and R need to match the C and R types that you passed into MsgTable::build().

Returns whether a connection was handled.

pub fn handle_new_cons<C: Any + Send + Sync, R: Any + Send + Sync>(
    &mut self,
    hook: impl FnMut(CId, C) -> (bool, R)
) -> u32

Handles all available new connection attempts in a loop, calling the given hook for each.

The hook function should return (should_accept, response_msg).

Types C and R need to match the C and R types that you passed into MsgTable::build().

Returns the number of handled connections.

pub fn handle_disconnect(&mut self, hook: impl FnMut(CId, Status)) -> bool

Handles a single disconnect, if there is one available to handle.

If there is no disconnects to handle, hook will not be called.

Returns weather it handled a disconnect.

pub fn handle_disconnects(&mut self, hook: impl FnMut(CId, Status)) -> u32

Handles all remaining disconnects.

Returns the number of disconnects handled.

pub fn send_to<T: Any + Send + Sync>(&self, cid: CId, msg: &T) -> Result<()>

Sends a message to the CId cid.

pub fn broadcast<T: Any + Send + Sync>(&self, msg: &T) -> Result<()>

Broadcasts a message to all connected clients.

pub fn send_spec<T: Any + Send + Sync>(
    &self,
    spec: CIdSpec,
    msg: &T
) -> Result<()>

Sends a message to all CIds that match spec.

pub fn recv<'s, T: Any + Send + Sync>(
    &'s self
) -> impl Iterator<Item = NetMsg<'_, T>> + 's

Gets an iterator for the messages of type T.

Make sure to call recv_msgs() before calling this.

Panics

Panics if the type T was not registered. For a non-panicking version, see try_recv().

pub fn try_recv<'s, T: Any + Send + Sync>(
    &'s self
) -> Option<impl Iterator<Item = NetMsg<'_, T>> + 's>

Gets an iterator for the messages of type T.

Make sure to call recv_msgs() before calling this.

Returns None if the type T was not registered.

pub fn recv_spec<T: Any + Send + Sync>(
    &self,
    spec: CIdSpec
) -> impl Iterator<Item = NetMsg<'_, T>> + '_

Gets an iterator for the messages of type T that have been received from CIds that match spec.

Make sure to call recv_msgs()

Panics

Panics if the type T was not registered. For a non-panicking version, see try_recv_spec().

pub fn try_recv_spec<T: Any + Send + Sync>(
    &self,
    spec: CIdSpec
) -> Option<impl Iterator<Item = NetMsg<'_, T>> + '_>

Gets an iterator for the messages of type T that have been received from CIds that match spec.

Make sure to call recv_msgs()

Returns None if the type T was not registered.

pub fn recv_msgs(&mut self) -> u32

Receives the messages from the connections. This should be done before calling recv<T>().

When done in a game loop, you should call clear_msgs(), then recv_msgs() before default time. This will clear the messages between frames.

pub fn clear_msgs(&mut self)

Clears messages from the buffer.

pub fn listen_addr(&self) -> SocketAddr

Gets the address that the server is listening on.

pub fn cids(&self) -> impl Iterator<Item = CId> + '_

An iterator of the CIds.

pub fn alive(&self, cid: CId) -> bool

Returns whether the connection of the given CId is alive.

pub fn valid_tid(&self, tid: TypeId) -> bool

Returns whether a message of type tid can be sent.

pub fn connection_count(&self) -> usize

The number of active connections. To ensure an accurate count, it is best to call this after calling handle_disconnects().

pub fn addr_of(&self, cid: CId) -> Option<SocketAddr>

Gets the address of the given CId.

pub fn cid_of(&self, addr: SocketAddr) -> Option<CId>

Gets the address of the given CId.