Struct Relay 

pub struct Relay<'a> { /* private fields */ }

A borrowed handle to one live allocation on the TURN server.

Obtained from Client::relay. Sending to a peer requires a permission for it first — see Self::create_permission.

Implementations

impl Relay<'_>

pub fn create_permission( &mut self, peer_addr: SocketAddr, ) -> Result<Option<TransactionId>>

Asks the server to permit traffic to and from peer_addr.

The relay silently drops data for peers with no permission, and permissions expire after five minutes unless refreshed. Returns the transaction id to match against the resulting Event, or None if a permission is already in place.

Errors

Fails if the allocation no longer exists or the request cannot be encoded.

pub fn send_to(&mut self, p: &[u8], peer_addr: SocketAddr) -> Result<()>

Sends p to peer_addr through the relay.

Uses ChannelData framing if a channel is bound for that peer, otherwise a Data indication.

Errors

Fails if the allocation is gone, or if no permission exists for peer_addr.

pub fn close(&mut self) -> Result<()>

Releases the allocation by refreshing it with a zero lifetime.

Errors

Fails if the refresh request cannot be sent.