P2PSessionBuilder

Struct P2PSessionBuilder 

Source
pub struct P2PSessionBuilder<T>
where T: Config,
{ /* private fields */ }
Expand description

A builder for P2PSession.

Implementations§

Source§

impl<T> P2PSessionBuilder<T>
where T: Config,

Source

pub fn new() -> Self

Creates a new builder. Identical to P2PSession::build.

Source

pub fn with_frame_delay(self, frame_delay: i32) -> Self

Sets how much frame delay is used for all active players. Defaults to 3 frames.

Source

pub fn with_disconnect_timeout(self, timeout: Duration) -> Self

Sets how long the client will wait for a packet from a remote player before considering the connection disconnected. Defaults to 5000ms.

Source

pub fn with_disconnect_notify_start(self, timeout: Duration) -> Self

Sets how long the client will wait for a packet from a remote player before before firing a Event::ConnectionInterrupted event. Defaults to 750ms.

Source

pub fn add_player(&mut self, player: Player) -> PlayerHandle

Adds a player to the session and returns the corresponding handle.

Source

pub fn start(self) -> BackrollResult<P2PSession<T>>

Constructs and starts the P2PSession. Consumes the builder.

§Errors

Returns BackrollError::MultipleLocalPlayers if there are multiple local players. Backroll currently only supports one local player.

Trait Implementations§

Source§

impl<T> Default for P2PSessionBuilder<T>
where T: Config,

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<T> Freeze for P2PSessionBuilder<T>

§

impl<T> RefUnwindSafe for P2PSessionBuilder<T>
where T: RefUnwindSafe,

§

impl<T> Send for P2PSessionBuilder<T>
where T: Send,

§

impl<T> Sync for P2PSessionBuilder<T>
where T: Sync,

§

impl<T> Unpin for P2PSessionBuilder<T>
where T: Unpin,

§

impl<T> UnwindSafe for P2PSessionBuilder<T>
where T: UnwindSafe,

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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, 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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more