MasqueRelayClient

Struct MasqueRelayClient 

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

MASQUE Relay Client

Manages a connection to a MASQUE relay server and provides APIs for sending and receiving datagrams through the relay.

Implementations§

Source§

impl MasqueRelayClient

Source

pub fn new(relay_address: SocketAddr, config: RelayClientConfig) -> Self

Create a new relay client (not yet connected)

Source

pub fn relay_address(&self) -> SocketAddr

Get relay server address

Source

pub async fn public_address(&self) -> Option<SocketAddr>

Get our public address (if known)

Source

pub async fn state(&self) -> RelayConnectionState

Get current connection state

Source

pub async fn is_connected(&self) -> bool

Check if connected

Source

pub async fn connection_duration(&self) -> Option<Duration>

Get connection duration

Source

pub fn stats(&self) -> Arc<RelayClientStats>

Get statistics

Source

pub fn create_connect_request(&self) -> ConnectUdpRequest

Create a CONNECT-UDP Bind request

Source

pub async fn handle_connect_response( &self, response: ConnectUdpResponse, ) -> RelayResult<()>

Handle the CONNECT-UDP response from the relay

Source

pub async fn handle_capsule( &self, capsule: Capsule, ) -> RelayResult<Option<Capsule>>

Handle an incoming capsule from the relay

Source

pub async fn get_or_create_context( &self, target: SocketAddr, ) -> RelayResult<(VarInt, Option<Capsule>)>

Get or create a context for a target address

Returns the context ID and an optional capsule to send (COMPRESSION_ASSIGN).

Source

pub async fn create_datagram( &self, target: SocketAddr, payload: Bytes, ) -> RelayResult<(Datagram, Option<Capsule>)>

Create a datagram for sending to a target

If a context exists and is active, returns a compressed datagram. Otherwise returns an uncompressed datagram (if allowed).

Source

pub async fn decode_datagram( &self, data: &[u8], ) -> RelayResult<(SocketAddr, Bytes)>

Decode an incoming datagram from the relay

Source

pub fn record_sent(&self, bytes: usize)

Record a sent datagram

Source

pub async fn close(&self)

Close the relay connection

Source

pub async fn active_contexts(&self) -> Vec<VarInt>

Get list of active context IDs

Trait Implementations§

Source§

impl Debug for MasqueRelayClient

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> 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<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