Enum ggrs::GGRSEvent

pub enum GGRSEvent<T>where
    T: Config,{
    Synchronizing {
        addr: T::Address,
        total: u32,
        count: u32,
    },
    Synchronized {
        addr: T::Address,
    },
    Disconnected {
        addr: T::Address,
    },
    NetworkInterrupted {
        addr: T::Address,
        disconnect_timeout: u128,
    },
    NetworkResumed {
        addr: T::Address,
    },
    WaitRecommendation {
        skip_frames: u32,
    },
    DesyncDetected {
        frame: Frame,
        local_checksum: u128,
        remote_checksum: u128,
        addr: T::Address,
    },
}

Notifications that you can receive from the session. Handling them is up to the user.

Variants

Synchronizing

Fields

addr: T::Address

The address of the endpoint.

total: u32

Total number of required successful synchronization steps.

count: u32

Current number of successful synchronization steps.

The session made progress in synchronizing. After total roundtrips, the session are synchronized.

Synchronized

Fields

addr: T::Address

The address of the endpoint.

The session is now synchronized with the remote client.

Disconnected

Fields

addr: T::Address

The address of the endpoint.

The remote client has disconnected.

NetworkInterrupted

Fields

addr: T::Address

The address of the endpoint.

disconnect_timeout: u128

The client will be disconnected in this amount of ms.

The session has not received packets from the remote client for some time and will disconnect the remote in disconnect_timeout ms.

NetworkResumed

Fields

addr: T::Address

The address of the endpoint.

Sent only after a GGRSEvent::NetworkInterrupted event, if communication with that player has resumed.

WaitRecommendation

Fields

skip_frames: u32

Amount of frames recommended to be skipped in order to let other clients catch up.

Sent out if GGRS recommends skipping a few frames to let clients catch up. If you receive this, consider waiting skip_frames number of frames.

DesyncDetected

Fields

frame: Frame

Frame of the checksums

local_checksum: u128

local checksum for the given frame

remote_checksum: u128

remote checksum for the given frame

addr: T::Address

remote address of the endpoint.

Sent whenever GGRS locally detected a discrepancy between local and remote checksums

Trait Implementations

impl<T> Clone for GGRSEvent<T>where T: Config + Clone, T::Address: Clone,

fn clone(&self) -> GGRSEvent<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T> Debug for GGRSEvent<T>where T: Config + Debug, T::Address: Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T> PartialEq<GGRSEvent<T>> for GGRSEvent<T>where T: Config + PartialEq, T::Address: PartialEq,

fn eq(&self, other: &GGRSEvent<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> Copy for GGRSEvent<T>where T: Config + Copy, T::Address: Copy,

impl<T> Eq for GGRSEvent<T>where T: Config + Eq, T::Address: Eq,

impl<T> StructuralEq for GGRSEvent<T>where T: Config,

impl<T> StructuralPartialEq for GGRSEvent<T>where T: Config,