Struct ggrs::SpectatorSession

pub struct SpectatorSession<T>where
    T: Config,{ /* private fields */ }

SpectatorSession provides all functionality to connect to a remote host in a peer-to-peer fashion. The host will broadcast all confirmed inputs to this session. This session can be used to spectate a session without contributing to the game input.

Implementations

impl<T: Config> SpectatorSession<T>

pub fn current_state(&self) -> SessionState

Returns the current SessionState of a session.

pub fn frames_behind_host(&self) -> usize

Returns the number of frames behind the host

pub fn network_stats(&self) -> Result<NetworkStats, GGRSError>

Used to fetch some statistics about the quality of the network connection.

Errors

• Returns NotSynchronized if the session is not connected to other clients yet.

pub fn events(&mut self) -> Drain<'_, GGRSEvent<T>>

Returns all events that happened since last queried for events. If the number of stored events exceeds MAX_EVENT_QUEUE_SIZE, the oldest events will be discarded.

pub fn advance_frame(&mut self) -> Result<Vec<GGRSRequest<T>>, GGRSError>

You should call this to notify GGRS that you are ready to advance your gamestate by a single frame. Returns an order-sensitive Vec<GGRSRequest>. You should fulfill all requests in the exact order they are provided. Failure to do so will cause panics later.

Errors

• Returns NotSynchronized if the session is not yet ready to accept input. In this case, you either need to start the session or wait for synchronization between clients.

pub fn poll_remote_clients(&mut self)

Receive UDP packages, distribute them to corresponding UDP endpoints, handle all occurring events and send all outgoing UDP packages. Should be called periodically by your application to give GGRS a chance to do internal work like packet transmissions.

pub fn num_players(&self) -> usize

Returns the number of players this session was constructed with.