Struct voxelize::Server

pub struct Server {
    pub port: u16,
    pub addr: String,
    pub started: bool,
    /* private fields */
}

A websocket server for Voxelize, holds all worlds data, and runs as a background system service.

Fields

port: u16

The port that this voxelize server is running on.

addr: String

The address that this voxelize server is running on.

started: bool

Whether or not if the socket server has started as a system service.

Implementations

impl Server

pub fn new() -> ServerBuilder

Create a new Voxelize server instance used to host all the worlds.

Example

// Create a server of port 4000 on "0.0.0.0"
let server = Server::new().addr("0.0.0.0").port(4000).build();

// Run the server on Voxelize
Voxelize::run(server);

pub fn prepare(&mut self)

Get ready to start the Voxelize server.

pub fn set_handler(&mut self, handler: NodeHandler<()>)

Assign a network handler to this server

pub fn add_endpoint(&mut self, endpoint: Endpoint)

Add an endpoint, without assigning them to a world. Endpoint(client) needs to pass a CONNECT type protocol buffer with a world name to be assigned to a world.

pub fn add_world(&mut self, world: World) -> Result<&mut World, AddWorldError>

Add a world instance to the server. Different worlds have different configurations, and can hold their own set of clients within. If the server has already started, the added world will be started right away.

pub fn create_world(
    &mut self,
    name: &str,
    config: &WorldConfig
) -> Result<&mut World, AddWorldError>

Create a world in the server. Different worlds have different configurations, and can hold their own set of clients within. If the server has already started, the added world will be started right away.

pub fn get_world(&self, world_name: &str) -> Option<&World>

Get a world reference by name.

pub fn get_world_mut(&mut self, world_name: &str) -> Option<&mut World>

Get a mutable world reference by name.

pub fn broadcast(&self, data: Message)

pub fn on_request(&mut self, endpoint: Endpoint, data: Message)

Handler for client’s message.

pub fn on_leave(&mut self, endpoint: Endpoint)

Handler for client leaving.

pub fn handler(&self) -> &NodeHandler<()>

Obtain the network handler.

pub fn tick(&mut self)