Struct amethyst_network::NetSocketSystem

pub struct NetSocketSystem<E: 'static> where
    E: PartialEq,  { /* fields omitted */ }

The System managing the network state from NetConnections.

This system has a few responsibilities.

• Reading to send packets from NetConnection and sending those over to some remote endpoint.
• Listening for incoming packets and queue the received packets (NetEvent::Packet(...)) on the accompanying NetConnection.

This system is able to create a NetConnection and add those to the world when a new client connects. (This behavior might not be desired and can therefore be deactivated in the configuration).

In both cases when a client connects and disconnects a NetEvent::Connected or NetEvent::Disconnected will be queued on accompanying NetConnection

• T corresponds to the network event type.

Methods

impl<E> NetSocketSystem<E> where
    E: Serialize + PartialEq + Send + 'static, 

pub fn new(config: ServerConfig) -> Result<Self>

Creates a NetSocketSystem and binds the Socket on the ip and port added in parameters.

Trait Implementations

impl<'a, E> System<'a> for NetSocketSystem<E> where
    E: Send + Sync + Serialize + Clone + DeserializeOwned + PartialEq + 'static, 

type SystemData = (WriteStorage<'a, NetConnection<E>>, Entities<'a>)

The resource bundle required to execute this system.

fn run(&mut self, (net_connections, entities): Self::SystemData)

Executes the system with the required system data.

fn running_time(&self) -> RunningTime

Returns a hint how long the system needs for running. This is used to optimize the way they're executed (might allow more parallelization).

fn accessor(&'b self) -> AccessorCow<'a, 'b, Self>

Return the accessor from the [SystemData].

fn setup(&mut self, world: &mut World)

Sets up the World using Self::SystemData::setup.

fn dispose(self, world: &mut World)

Performs clean up that requires resources from the World. This commonly removes components from world which depend on external resources.