Struct naia_server::NaiaServer

pub struct NaiaServer<T: EventType, U: EntityType> { /* fields omitted */ }

A server that uses either UDP or WebRTC communication to send/receive events to/from connected clients, and syncs registered entities to clients to whom those entities are in-scope

Implementations

impl<T: EventType, U: EntityType> NaiaServer<T, U>

pub async fn new(
    address: SocketAddr,
    manifest: Manifest<T, U>,
    config: Option<Config>
) -> Self

Create a new Server, given an address to listen at, an Event/Entity manifest, and an optional Config

pub async fn receive<'_>(
    &'_ mut self
) -> Result<ServerEvent<T>, NaiaServerError>

Must be called regularly, maintains connection to and receives messages from all Clients

pub fn queue_event(&mut self, user_key: &UserKey, event: &impl Event<T>)

Queues up an Event to be sent to the Client associated with a given UserKey

pub async fn send_all_updates<'_>(&'_ mut self)

Sends all Entity/Event messages to all Clients. If you don't call this method, the Server will never communicate with it's connected Clients

pub fn register_entity(
    &mut self,
    entity: Rc<RefCell<dyn Entity<U>>>
) -> EntityKey

Register an Entity with the Server, whereby the Server will sync the state of the Entity to all connected Clients for which the Entity is in scope. Gives back an EntityKey which can be used to get the reference to the Entity from the Server once again

pub fn deregister_entity(&mut self, key: EntityKey)

Deregisters an Entity with the Server, deleting local copies of the Entity on each Client

pub fn get_entity(
    &mut self,
    key: EntityKey
) -> Option<&Rc<RefCell<dyn Entity<U>>>>

Given an EntityKey, get a reference to a registered Entity being tracked by the Server

pub fn create_room(&mut self) -> RoomKey

Creates a new Room on the Server, returns a Key which can be used to reference said Room

pub fn delete_room(&mut self, key: RoomKey)

Deletes the Room associated with a given RoomKey on the Server

pub fn get_room(&self, key: RoomKey) -> Option<&Room>

Gets a Room given an associated RoomKey

pub fn get_room_mut(&mut self, key: RoomKey) -> Option<&mut Room>

Gets a mutable Room given an associated RoomKey

pub fn rooms_iter(&self) -> Iter<RoomKey, Room>

Iterate through all the Server's current Rooms

pub fn room_add_entity(&mut self, room_key: &RoomKey, entity_key: &EntityKey)

Add an Entity to a Room, given the appropriate RoomKey & EntityKey Entities will only ever be in-scope for Users which are in a Room with them

pub fn room_add_user(&mut self, room_key: &RoomKey, user_key: &UserKey)

Add an User to a Room, given the appropriate RoomKey & UserKey Entities will only ever be in-scope for Users which are in a Room with them

pub fn on_scope_entity(
    &mut self,
    scope_func: Rc<Box<dyn Fn(&RoomKey, &UserKey, &EntityKey, U) -> bool>>
)

Registers a closure which is used to evaluate whether, given a User & Entity that are in the same Room, said Entity should be in scope for the given User.

While Rooms allow for a very simple scope to which an Entity can belong, this closure provides complete customization for advanced scopes.

This closure will be called every Tick of the Server, for every User & Entity in a Room together, so try to keep it performant

pub fn on_auth(&mut self, auth_func: Rc<Box<dyn Fn(&UserKey, &T) -> bool>>)

Registers a closure which will be called during the handshake process with a new Client

The Event evaluated in this closure should match the Event used client-side in the NaiaClient::new() method

pub fn get_rtt(&mut self, user_key: &UserKey) -> Option<f32>

Get the current measured Round Trip Time to the Server

pub fn users_iter(&self) -> Iter<UserKey, User>

Iterate through all currently connected Users

pub fn get_user(&self, user_key: &UserKey) -> Option<&User>

Get a User, given the associated UserKey