Skip to main content

NetResource

Struct NetResource 

Source
pub struct NetResource { /* private fields */ }
Expand description

Bevy resource that owns the networking transport and packet queues.

Implementations§

Source§

impl NetResource

Source

pub fn new() -> Self

Creates an empty networking resource.

Source

pub fn is_server(&self) -> bool

Returns true when the resource is currently running as server.

Source

pub fn join_server(&mut self, server_address: String)

Connects to a server and binds packet handlers to the new socket.

Examples found in repository?
examples/messages_demo.rs (line 110)
103fn setup(mut net: ResMut<NetResource>, mode: Res<DemoMode>) {
104    match mode.0 {
105        Mode::Server => {
106            net.start_server(5002);
107            println!("server listening on {ADDRESS}");
108        }
109        Mode::Client => {
110            net.join_server(ADDRESS.to_string());
111            println!("client connected to {ADDRESS}");
112        }
113    }
114}
More examples
Hide additional examples
examples/replication_demo.rs (line 67)
55fn setup(mut commands: Commands, mut net: ResMut<NetResource>, mode: Res<DemoMode>) {
56    match mode.0 {
57        Mode::Server => {
58            net.start_server(5001);
59            println!("server listening on {ADDRESS}");
60            commands.spawn((
61                Replicated,
62                Position(Vec2::ZERO),
63                Health(100),
64            ));
65        }
66        Mode::Client => {
67            net.join_server(ADDRESS.to_string());
68            println!("client connected to {ADDRESS}");
69        }
70    }
71}
examples/cubes_demo.rs (line 89)
71fn setup(mut commands: Commands, mut net: ResMut<NetResource>, mode: Res<DemoMode>) {
72    match mode.0 {
73        Mode::Server => {
74            net.start_server(5003);
75            println!("server listening on {ADDRESS}");
76
77            for index in 0..5 {
78                commands.spawn((
79                    Replicated,
80                    Position(Vec2::new(index as f32 * 80.0 - 160.0, 0.0)),
81                    Velocity(Vec2::new(
82                        70.0 + index as f32 * 15.0,
83                        40.0 + index as f32 * 10.0,
84                    )),
85                ));
86            }
87        }
88        Mode::Client => {
89            net.join_server(ADDRESS.to_string());
90            println!("client connected to {ADDRESS}");
91        }
92    }
93}
Source

pub fn start_server(&mut self, port: u16)

Starts the server and installs the connection callback.

Examples found in repository?
examples/messages_demo.rs (line 106)
103fn setup(mut net: ResMut<NetResource>, mode: Res<DemoMode>) {
104    match mode.0 {
105        Mode::Server => {
106            net.start_server(5002);
107            println!("server listening on {ADDRESS}");
108        }
109        Mode::Client => {
110            net.join_server(ADDRESS.to_string());
111            println!("client connected to {ADDRESS}");
112        }
113    }
114}
More examples
Hide additional examples
examples/replication_demo.rs (line 58)
55fn setup(mut commands: Commands, mut net: ResMut<NetResource>, mode: Res<DemoMode>) {
56    match mode.0 {
57        Mode::Server => {
58            net.start_server(5001);
59            println!("server listening on {ADDRESS}");
60            commands.spawn((
61                Replicated,
62                Position(Vec2::ZERO),
63                Health(100),
64            ));
65        }
66        Mode::Client => {
67            net.join_server(ADDRESS.to_string());
68            println!("client connected to {ADDRESS}");
69        }
70    }
71}
examples/cubes_demo.rs (line 74)
71fn setup(mut commands: Commands, mut net: ResMut<NetResource>, mode: Res<DemoMode>) {
72    match mode.0 {
73        Mode::Server => {
74            net.start_server(5003);
75            println!("server listening on {ADDRESS}");
76
77            for index in 0..5 {
78                commands.spawn((
79                    Replicated,
80                    Position(Vec2::new(index as f32 * 80.0 - 160.0, 0.0)),
81                    Velocity(Vec2::new(
82                        70.0 + index as f32 * 15.0,
83                        40.0 + index as f32 * 10.0,
84                    )),
85                ));
86            }
87        }
88        Mode::Client => {
89            net.join_server(ADDRESS.to_string());
90            println!("client connected to {ADDRESS}");
91        }
92    }
93}
Source

pub fn queue_packet(&mut self, packet: ReplicationPacket)

Adds a replication packet to the outgoing queue.

Source

pub fn send_packet_to(&self, socket: &Socket, packet: ReplicationPacket)

Sends a replication packet immediately to one socket.

Source

pub fn inject_packet(&mut self, packet: ReplicationPacket)

Injects a packet directly into the incoming queue.

Source

pub fn queue_message<T: NetMessage>(&mut self, message: T)

Queues a typed network message for broadcast.

Examples found in repository?
examples/messages_demo.rs (lines 126-128)
120fn server_handle_messages(
121    mut commands: Commands,
122    mut net: ResMut<NetResource>,
123) {
124    for chat in net.drain_messages::<ChatSend>() {
125        println!("chat: {}", chat.text);
126        net.queue_message(ChatBroadcast {
127            text: format!("server heard: {}", chat.text),
128        });
129    }
130
131    for shot in net.drain_messages::<ShootProjectile>() {
132        println!("shoot request from client: {:?} -> {:?}", shot.origin, shot.direction);
133        commands.spawn((
134            Replicated,
135            Projectile,
136            Position(shot.origin),
137            Velocity(shot.direction.normalize_or_zero() * 150.0),
138        ));
139    }
140}
141
142fn server_move_projectiles(
143    time: Res<Time>,
144    mut query: Query<(&mut Position, &Velocity), With<Projectile>>,
145) {
146    for (mut position, velocity) in &mut query {
147        position.0 += velocity.0 * time.delta_secs();
148    }
149}
150
151fn client_send_messages(
152    time: Res<Time>,
153    mut tick: Local<f32>,
154    mut net: ResMut<NetResource>,
155) {
156    *tick += time.delta_secs();
157    if *tick < 1.0 {
158        return;
159    }
160    *tick = 0.0;
161
162    net.queue_message(ChatSend {
163        text: "hello from client".to_string(),
164    });
165    net.queue_message(ShootProjectile {
166        origin: Vec2::new(0.0, 0.0),
167        direction: Vec2::new(1.0, 0.2),
168    });
169}
Source

pub fn drain_outbox(&mut self) -> Vec<ReplicationPacket>

Drains all queued outgoing replication packets.

Source

pub fn drain_inbox(&mut self) -> Vec<ReplicationPacket>

Drains all received replication packets.

Source

pub fn drain_new_connections(&mut self) -> Vec<Socket>

Drains sockets that connected since the last snapshot broadcast.

Source

pub fn drain_message_inbox(&mut self) -> Vec<RawNetMessage>

Drains raw messages regardless of wire type.

Source

pub fn drain_messages<T: NetMessage>(&mut self) -> Vec<T>

Extracts only messages of type T, leaving the rest queued.

Examples found in repository?
examples/messages_demo.rs (line 124)
120fn server_handle_messages(
121    mut commands: Commands,
122    mut net: ResMut<NetResource>,
123) {
124    for chat in net.drain_messages::<ChatSend>() {
125        println!("chat: {}", chat.text);
126        net.queue_message(ChatBroadcast {
127            text: format!("server heard: {}", chat.text),
128        });
129    }
130
131    for shot in net.drain_messages::<ShootProjectile>() {
132        println!("shoot request from client: {:?} -> {:?}", shot.origin, shot.direction);
133        commands.spawn((
134            Replicated,
135            Projectile,
136            Position(shot.origin),
137            Velocity(shot.direction.normalize_or_zero() * 150.0),
138        ));
139    }
140}
141
142fn server_move_projectiles(
143    time: Res<Time>,
144    mut query: Query<(&mut Position, &Velocity), With<Projectile>>,
145) {
146    for (mut position, velocity) in &mut query {
147        position.0 += velocity.0 * time.delta_secs();
148    }
149}
150
151fn client_send_messages(
152    time: Res<Time>,
153    mut tick: Local<f32>,
154    mut net: ResMut<NetResource>,
155) {
156    *tick += time.delta_secs();
157    if *tick < 1.0 {
158        return;
159    }
160    *tick = 0.0;
161
162    net.queue_message(ChatSend {
163        text: "hello from client".to_string(),
164    });
165    net.queue_message(ShootProjectile {
166        origin: Vec2::new(0.0, 0.0),
167        direction: Vec2::new(1.0, 0.2),
168    });
169}
170
171fn client_print_broadcasts(mut net: ResMut<NetResource>) {
172    for chat in net.drain_messages::<ChatBroadcast>() {
173        println!("broadcast: {}", chat.text);
174    }
175}
Source

pub fn flush_outbox(&mut self)

Serializes and flushes all queued packets to connected clients.

Source

pub fn poll_incoming(&mut self)

Placeholder hook for future socket polling implementations.

Trait Implementations§

Source§

impl Default for NetResource

Source§

fn default() -> NetResource

Returns the “default value” for a type. Read more
Source§

impl Resource for NetResource
where Self: Send + Sync + 'static,

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T, U> AsBindGroupShaderType<U> for T
where U: ShaderType, &'a T: for<'a> Into<U>,

Source§

fn as_bind_group_shader_type(&self, _images: &RenderAssets<GpuImage>) -> U

Return the T ShaderType for self. When used in AsBindGroup derives, it is safe to assume that all images in self exist.
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> ConditionalSend for T
where T: Send,

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Converts Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Converts Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Converts &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Converts &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSend for T
where T: Any + Send,

Source§

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<S> FromSample<S> for S

Source§

fn from_sample_(s: S) -> S

Source§

impl<T> FromWorld for T
where T: Default,

Source§

fn from_world(_world: &mut World) -> T

Creates Self using default().

Source§

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

Source§

const WITNESS: W = W::MAKE

A constant of the type witness
Source§

impl<T> Identity for T
where T: ?Sized,

Source§

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
Source§

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> IntoResult<T> for T

Source§

fn into_result(self) -> Result<T, RunSystemError>

Converts this type into the system output type.
Source§

impl<A> Is for A
where A: Any,

Source§

fn is<T>() -> bool
where T: Any,

Checks if the current type “is” another type, using a TypeId equality comparison. This is most useful in the context of generic logic. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Settings for T
where T: 'static + Send + Sync,

Source§

impl<T, U> ToSample<U> for T
where U: FromSample<T>,

Source§

fn to_sample_(self) -> U

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more