Skip to main content

RaknetClient

Struct RaknetClient 

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

Single-session high-level RakNet client.

Implementations§

Source§

impl RaknetClient

Source

pub async fn connect(server_addr: SocketAddr) -> ClientResult<Self>

Connects with default RaknetClientConfig.

Source

pub async fn connect_with_retry( server_addr: SocketAddr, config: RaknetClientConfig, policy: ReconnectPolicy, ) -> ClientResult<Self>

Connects with retry policy.

Source

pub async fn connect_with_config( server_addr: SocketAddr, config: RaknetClientConfig, ) -> ClientResult<Self>

Connects using explicit client configuration.

Source

pub fn local_addr(&self) -> Result<SocketAddr>

Returns local socket address used by this client.

Source

pub fn server_addr(&self) -> SocketAddr

Returns remote server address.

Source

pub fn metrics_snapshot(&self) -> SessionMetricsSnapshot

Returns session-level metrics snapshot.

Source

pub async fn send(&mut self, payload: impl Into<Bytes>) -> ClientResult<()>

Sends payload with default send options.

Source

pub async fn send_with_options( &mut self, payload: impl Into<Bytes>, options: ClientSendOptions, ) -> ClientResult<()>

Sends payload with explicit options.

Source

pub async fn send_with_receipt( &mut self, payload: impl Into<Bytes>, receipt_id: u64, options: ClientSendOptions, ) -> ClientResult<()>

Sends payload and tracks a receipt id.

Source

pub async fn disconnect(&mut self, reason_code: Option<u8>) -> ClientResult<()>

Gracefully disconnects client.

Source

pub async fn next_event(&mut self) -> Option<RaknetClientEvent>

Polls next client event.

Returns None once client is fully closed and pending events are drained.

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

Source§

type Output = T

Should always be Self
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<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