Struct RawConnection

pub struct RawConnection {
    pub reader: RawConnectionReader,
    pub writer: RawConnectionWriter,
    pub read_packets_task: JoinHandle<()>,
    pub write_packets_task: JoinHandle<()>,
    pub connection_protocol: ConnectionProtocol,
}

A component for clients that can read and write packets to the server. This works with raw bytes, so you’ll have to serialize/deserialize packets yourself. It will do the compression and encryption for you though.

Fields

reader: RawConnectionReader

writer: RawConnectionWriter

read_packets_task: JoinHandle<()>

Packets sent to this will be sent to the server. A task that reads packets from the server. The client is disconnected when this task ends.

write_packets_task: JoinHandle<()>

A task that writes packets from the server.

connection_protocol: ConnectionProtocol

Implementations

impl RawConnection

pub fn new( run_schedule_sender: UnboundedSender<()>, connection_protocol: ConnectionProtocol, raw_read_connection: RawReadConnection, raw_write_connection: RawWriteConnection, ) -> RawConnection

pub fn write_raw_packet( &self, raw_packet: Box<[u8]>, ) -> Result<(), WritePacketError>

pub fn write_packet<P>( &self, packet: impl Packet<P>, ) -> Result<(), WritePacketError>

where P: ProtocolPacket + Debug,

Write the packet with the given state to the server.

Errors

Returns an error if the packet is not valid for the current state, or if encoding it failed somehow (like it’s too big or something).

pub fn is_alive(&self) -> bool

Returns whether the connection is still alive.

pub fn incoming_packet_queue(&self) -> Arc<Mutex<RawMutex, Vec<Box<[u8]>>>>

pub fn set_state(&mut self, connection_protocol: ConnectionProtocol)

Trait Implementations

impl Component for RawConnection

where RawConnection: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::Table

A constant indicating the storage type used for this component.

fn register_required_components( requiree: ComponentId, components: &mut Components, storages: &mut Storages, required_components: &mut RequiredComponents, inheritance_depth: u16, )

Registers required components.

fn register_component_hooks(hooks: &mut ComponentHooks)

Called when registering this component, allowing mutable access to its [ComponentHooks].

impl Drop for RawConnection

fn drop(&mut self)

Stop every active task when this RawConnection is dropped.