Trait TurnClientApi 

pub trait TurnClientApi: Debug + Send {
    // Required methods
    fn transport(&self) -> TransportType;
    fn local_addr(&self) -> SocketAddr;
    fn remote_addr(&self) -> SocketAddr;
    fn relayed_addresses(
        &self,
    ) -> impl Iterator<Item = (TransportType, SocketAddr)>;
    fn permissions(
        &self,
        transport: TransportType,
        relayed: SocketAddr,
    ) -> impl Iterator<Item = IpAddr>;
    fn delete(&mut self, now: Instant) -> Result<(), DeleteError>;
    fn create_permission(
        &mut self,
        transport: TransportType,
        peer_addr: IpAddr,
        now: Instant,
    ) -> Result<(), CreatePermissionError>;
    fn have_permission(&self, transport: TransportType, to: IpAddr) -> bool;
    fn bind_channel(
        &mut self,
        transport: TransportType,
        peer_addr: SocketAddr,
        now: Instant,
    ) -> Result<(), BindChannelError>;
    fn tcp_connect(
        &mut self,
        peer_addr: SocketAddr,
        now: Instant,
    ) -> Result<(), TcpConnectError>;
    fn allocated_tcp_socket(
        &mut self,
        id: u32,
        five_tuple: Socket5Tuple,
        peer_addr: SocketAddr,
        local_addr: Option<SocketAddr>,
        now: Instant,
    ) -> Result<(), TcpAllocateError>;
    fn tcp_closed(
        &mut self,
        local_addr: SocketAddr,
        remote_addr: SocketAddr,
        now: Instant,
    );
    fn send_to<T>(
        &mut self,
        transport: TransportType,
        to: SocketAddr,
        data: T,
        now: Instant,
    ) -> Result<Option<TransmitBuild<DelayedMessageOrChannelSend<T>>>, SendError>
       where T: AsRef<[u8]> + Debug;
    fn recv<T>(&mut self, transmit: Transmit<T>, now: Instant) -> TurnRecvRet<T>
       where T: AsRef<[u8]> + Debug;
    fn poll_recv(&mut self, now: Instant) -> Option<TurnPeerData<Vec<u8>>>;
    fn poll(&mut self, now: Instant) -> TurnPollRet;
    fn poll_transmit(&mut self, now: Instant) -> Option<Transmit<Data<'static>>>;
    fn poll_event(&mut self) -> Option<TurnEvent>;
    fn protocol_error(&mut self);
}

The public API of a TURN client.

Required Methods

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.

Requires that a TCP allocation has been allocated on the TURN server.

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.

The values @id, @five_tuple, and @peer_addr must match the values provided in matching the TurnPollRet::AllocateTcpSocket.

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>( &mut self, transport: TransportType, to: SocketAddr, data: T, now: Instant, ) -> Result<Option<TransmitBuild<DelayedMessageOrChannelSend<T>>>, SendError>

where T: AsRef<[u8]> + Debug,

Send data to a peer through the TURN server.

The provided transport, address and data are the data to send to the peer.

The returned value may instruct the caller to send a message to the turn server.

fn recv<T>(&mut self, transmit: Transmit<T>, now: Instant) -> TurnRecvRet<T>

where T: AsRef<[u8]> + Debug,

Provide received data to the TURN client for handling.

The return value outlines what to do with this data.

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.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors

impl TurnClientApi for TurnClient

impl TurnClientApi for TurnClientOpensslTls

impl TurnClientApi for TurnClientTcp

impl TurnClientApi for TurnClientUdp