Enum TurnClient 

pub enum TurnClient {
    Udp(TurnClientUdp),
    Tcp(TurnClientTcp),
}

A TURN client.

Variants

Udp(TurnClientUdp)

A TurnClientUdp TURN client.

Tcp(TurnClientTcp)

A TurnClientTcp TURN client.

Trait Implementations

impl Debug for TurnClient

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

Formats the value using the given formatter.

impl From<TurnClientTcp> for TurnClient

fn from(value: TurnClientTcp) -> Self

Converts to this type from the input type.

impl From<TurnClientUdp> for TurnClient

fn from(value: TurnClientUdp) -> Self

Converts to this type from the input type.

impl TurnClientApi for TurnClient

fn transport(&self) -> TransportType

The transport of the connection to the TURN server.

fn local_addr(&self) -> SocketAddr

The local address of this TURN client.

fn remote_addr(&self) -> SocketAddr

The remote TURN server’s address.

fn relayed_addresses( &self, ) -> impl Iterator<Item = (TransportType, SocketAddr)> + '_

The list of allocated relayed addresses on the TURN server.

fn permissions( &self, transport: TransportType, relayed: SocketAddr, ) -> impl Iterator<Item = IpAddr> + '_

The list of permissions available for the provided relayed address.

fn delete(&mut self, now: Instant) -> Result<(), DeleteError>

Remove the allocation/s on the server.

fn create_permission( &mut self, transport: TransportType, peer_addr: IpAddr, now: Instant, ) -> Result<(), CreatePermissionError>

Create a permission address to allow sending/receiving data to/from.

fn have_permission(&self, transport: TransportType, to: IpAddr) -> bool

Whether the client currently has a permission installed for the provided transport and address.

fn bind_channel( &mut self, transport: TransportType, peer_addr: SocketAddr, now: Instant, ) -> Result<(), BindChannelError>

Bind a channel for sending/receiving data to/from a particular peer.

fn tcp_connect( &mut self, peer_addr: SocketAddr, now: Instant, ) -> Result<(), TcpConnectError>

Attempt to connect to a peer from the TURN server using TCP.

fn allocated_tcp_socket( &mut self, id: u32, five_tuple: Socket5Tuple, peer_addr: SocketAddr, local_addr: Option<SocketAddr>, now: Instant, ) -> Result<(), TcpAllocateError>

Indicate success (or failure) to create a socket for the specified server and peer address.

fn tcp_closed( &mut self, local_addr: SocketAddr, remote_addr: SocketAddr, now: Instant, )

Indicate that the TCP connection has been closed.

fn send_to<T: AsRef<[u8]> + Debug>( &mut self, transport: TransportType, to: SocketAddr, data: T, now: Instant, ) -> Result<Option<TransmitBuild<DelayedMessageOrChannelSend<T>>>, SendError>

Send data to a peer through the TURN server.

fn recv<T: AsRef<[u8]> + Debug>( &mut self, transmit: Transmit<T>, now: Instant, ) -> TurnRecvRet<T>

Provide received data to the TURN client for handling.

fn poll_recv(&mut self, now: Instant) -> Option<TurnPeerData<Vec<u8>>>

Poll the client for any further received data.

fn poll(&mut self, now: Instant) -> TurnPollRet

Poll the client for further progress.

fn poll_transmit(&mut self, now: Instant) -> Option<Transmit<Data<'static>>>

Poll for a packet to send.

fn poll_event(&mut self) -> Option<TurnEvent>

Poll for an event that has occurred.

fn protocol_error(&mut self)

A higher layer has encountered an error and this client is no longer usable.