lightyear_sync 0.27.0

IO primitives for the lightyear networking library
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55

//! # Lightyear Sync
//!
//! This crate provides the synchronization layer for the Lightyear networking library.
//! It handles time synchronization between peers, including:
//! - Ping and RTT estimation (`ping`).
//! - Timeline synchronization to align game state across different peers (`timeline`).
//! - Client and server-specific synchronization logic.
//!
//! The core idea is to allow peers to maintain a synchronized understanding of game time,
//! which is crucial for consistent simulation and prediction.
#![no_std]

extern crate alloc;
#[cfg(feature = "std")]
extern crate std;

#[cfg(feature = "client")]
/// Client-specific synchronization logic.
pub mod client;
/// Manages pinging and RTT estimation between peers.
pub mod ping;

// TODO: server: we might want each ClientOf to use the timeline of the parent

#[cfg(feature = "server")]
/// Server-specific synchronization logic.
pub mod server;

/// Provides the `SyncPlugin` for integrating synchronization into a Bevy app.
pub mod plugin;
/// Defines timelines and their synchronization mechanisms.
pub mod timeline;

/// Commonly used items from the `lightyear_sync` crate.
pub mod prelude {
    pub use crate::ping::PingChannel;
    pub use crate::ping::manager::{PingConfig, PingManager};
    pub use crate::ping::message::{Ping, Pong};
    pub use crate::plugin::{SyncSystems, TimelineSyncPlugin};
    pub use crate::timeline::sync::{IsSynced, SyncConfig};
    pub use crate::timeline::{
        DrivingTimeline,
        input::{InputTimeline, InputTimelineConfig},
    };

    #[cfg(feature = "client")]
    pub mod client {
        pub use crate::timeline::input::{InputDelayConfig, InputTimeline, InputTimelineConfig};
        pub use crate::timeline::remote::{RemoteEstimate, RemoteTimeline};
        pub use crate::timeline::sync::IsSynced;
    }

    #[cfg(feature = "server")]
    pub mod server {}
}