Enum bones_framework::external::ggrs::GgrsEvent

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

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

Variants

Synchronizing

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

Fields

addr: <T as Config>::Address

The address of the endpoint.

total: u32

Total number of required successful synchronization steps.

count: u32

Current number of successful synchronization steps.

Synchronized

The session is now synchronized with the remote client.

Fields

addr: <T as Config>::Address

The address of the endpoint.

Disconnected

The remote client has disconnected.

Fields

addr: <T as Config>::Address

The address of the endpoint.

NetworkInterrupted

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

Fields

addr: <T as Config>::Address

The address of the endpoint.

disconnect_timeout: u128

The client will be disconnected in this amount of ms.

NetworkResumed

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

Fields

addr: <T as Config>::Address

The address of the endpoint.

WaitRecommendation

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.

Fields

skip_frames: u32

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

DesyncDetected

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

Fields

frame: i32

Frame of the checksums

local_checksum: u128

local checksum for the given frame

remote_checksum: u128

remote checksum for the given frame

addr: <T as Config>::Address

remote address of the endpoint.

Trait Implementations

impl<T> Clone for GgrsEvent<T>

where T: Clone + Config, <T as Config>::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: Debug + Config, <T as Config>::Address: Debug,

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

Formats the value using the given formatter.

impl<T> PartialEq for GgrsEvent<T>

where T: PartialEq + Config, <T as Config>::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: Copy + Config, <T as Config>::Address: Copy,

impl<T> Eq for GgrsEvent<T>

where T: Eq + Config, <T as Config>::Address: Eq,

impl<T> StructuralPartialEq for GgrsEvent<T>

where T: Config,