Struct bevy_replicon::client::replicon_client::RepliconClient

pub struct RepliconClient { /* private fields */ }

Stores information about a client independent from the messaging backend.

The messaging backend is responsible for updating this resource:

• When the messaging client changes its status (connected, connecting and disconnected), Self::set_status should be used to reflect this.
• For receiving messages, Self::insert_received should be to used. A system to forward backend messages to Replicon should run in ClientSet::ReceivePackets.
• For sending messages, Self::drain_sent should be used to drain all sent messages. A system to forward Replicon messages to the backend should run in ClientSet::SendPackets.

Implementations

impl RepliconClient

pub fn receive<I: Into<u8>>( &mut self, channel_id: I, ) -> impl Iterator<Item = Bytes> + '_

Receives all available messages from the server over a channel.

All messages will be drained.

pub fn send<I: Into<u8>, B: Into<Bytes>>(&mut self, channel_id: I, message: B)

Sends a message to the server over a channel.

pub fn set_status(&mut self, status: RepliconClientStatus)

Sets the client connection status.

Should be called only from the messaging backend when the client status changes. Discards all messages if the state changes from RepliconClientStatus::Connected. See also Self::status.

pub fn status(&self) -> RepliconClientStatus

Returns the current client status.

See also Self::set_status.

pub fn is_disconnected(&self) -> bool

Returns true if the client is disconnected.

See also Self::status.

pub fn is_connecting(&self) -> bool

Returns true if the client is connecting.

See also Self::status.

pub fn is_connected(&self) -> bool

Returns true if the client is connected.

See also Self::status.

pub fn id(&self) -> Option<ClientId>

Returns the client’s ID.

The client ID is available only if the client state is RepliconClientStatus::Connected. See also Self::status.

pub fn drain_sent(&mut self) -> impl Iterator<Item = (u8, Bytes)> + '_

Removes all sent messages, returning them as an iterator with channel.

Should be called only from the messaging backend.

pub fn insert_received<I: Into<u8>, B: Into<Bytes>>( &mut self, channel_id: I, message: B, )

Adds a message from the server to the list of received messages.

Should be called only from the messaging backend.

Trait Implementations

impl Default for RepliconClient

fn default() -> RepliconClient

Returns the “default value” for a type.

impl Resource for RepliconClient

where Self: Send + Sync + 'static,