Skip to main content

InputReceiver

Struct InputReceiver 

Source
pub struct InputReceiver { /* private fields */ }
Expand description

Server-side packet validator and out-of-order de-duplicator for one client stream.

Implementations§

Source§

impl InputReceiver

Source

pub fn new(config: InputReceiverConfig) -> NetcodeResult<Self>

Creates a receiver expecting sequence one next.

Source

pub fn with_acknowledged( config: InputReceiverConfig, acknowledged: u64, ) -> NetcodeResult<Self>

Restores a receiver from a previously persisted cumulative acknowledgement.

Source

pub fn receive<T>( &mut self, current_server_tick: u64, packet: InputPacket<T>, ) -> NetcodeResult<InputReceiveReport<T>>

Validates a packet at the current server Tick and returns only newly accepted inputs.

Packet processing is transactional: one invalid new frame leaves the receive window unchanged. Already received redundant frames are ignored even after their target Tick ages out of the configured rollback window.

Source

pub fn acknowledged_sequence(&self) -> u64

Returns the highest contiguous received input sequence.

Source

pub fn pending_sequences(&self) -> usize

Returns the number of out-of-order sequences waiting for a gap.

Trait Implementations§

Source§

impl Clone for InputReceiver

Source§

fn clone(&self) -> InputReceiver

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for InputReceiver

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.