Struct carrier_pigeon::Client

pub struct Client { /* private fields */ }

A Client connection.

This can only connect to 1 server.

Contains a TCP and UDP connection to the server.

Implementations

impl Client

pub fn new<C: Any + Send + Sync>(
    peer: SocketAddr,
    parts: MsgTableParts,
    config: Config,
    con_msg: C
) -> PendingClient

Creates a new Client.

Creates a new Client on another thread, passing back a PendingClient. This PendingClient allows you to wait for the client to send the connection message, and for the server to send back the response message.

pub fn config(&self) -> &Config

Gets the config of the client.

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

Disconnects from the server. You should call this method before dropping the client to let the server know that you intentionally disconnected. The discon_msg allows you to give a reason for the disconnect.

pub fn status(&self) -> &Status

Gets the status of the connection.

pub fn open(&self) -> bool

Returns whether the connection is open.

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

Sends a message to the peer.

T must be registered in the [MsgTable].

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

Gets an iterator for the messages of type T.

Panics

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

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

Gets an iterator for the messages of type T.

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 local_addr(&self) -> Result<SocketAddr>

Gets the local address.

pub fn peer_addr(&self) -> Result<SocketAddr>

Gets the address of the peer.

Trait Implementations

impl Debug for Client

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

Formats the value using the given formatter.