Struct RelayConn

pub struct RelayConn { /* private fields */ }

A connection to a relay server.

Cheaply clonable. Call close to shut down the write loop and read functionality.

Implementations

impl Conn

pub async fn send(&self, dstkey: PublicKey, packet: Bytes) -> Result<()>

Sends a packet to the node identified by dstkey

Errors if the packet is larger than MAX_PACKET_SIZE

pub async fn send_ping(&self, data: [u8; 8]) -> Result<()>

Send a ping with 8 bytes of random data.

pub async fn send_pong(&self, data: [u8; 8]) -> Result<()>

Respond to a ping request. The data field should be filled by the 8 bytes of random data send by the ping.

pub async fn note_preferred(&self, preferred: bool) -> Result<()>

Sends a packet that tells the server whether this connection is to the user’s preferred server. This is only used in the server for stats.

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

The local address that the Conn is listening on.

None, when run in a testing environment or when using websockets.

pub fn is_closed(&self) -> bool

Whether or not this Conn is closed.

The Conn is considered closed if the write side of the connection is no longer running.

pub async fn close(&self)

Close the connection

Shuts down the write loop directly and marks the connection as closed. The Conn will check if the it is closed before attempting to read from it.

Trait Implementations

impl Clone for Conn

fn clone(&self) -> Conn

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Conn

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

Formats the value using the given formatter.

impl PartialEq for Conn

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Conn