Struct webrtc_unreliable::Server

pub struct Server { /* fields omitted */ }

Implementations

impl Server

pub async fn new(
    listen_addr: SocketAddr,
    public_addr: SocketAddr
) -> Result<Server, IoError>

Start a new WebRTC data channel server listening on listen_addr and advertising its publicly available address as public_addr.

WebRTC connections must be started via an external communication channel from a browser via the SessionEndpoint, after which a WebRTC data channel can be opened.

pub fn session_endpoint(&self) -> SessionEndpoint

Returns a SessionEndpoint which can be used to start new WebRTC sessions.

WebRTC connections must be started via an external communication channel from a browser via the returned SessionEndpoint, and this communication channel will be used to exchange session descriptions in SDP format.

The returned SessionEndpoint will notify this Server of new sessions via a shared async channel. This is done so that the SessionEndpoint is easy to use in a separate server task (such as a hyper HTTP server).

pub fn connected_clients(&self) -> impl Iterator<Item = &SocketAddr> + '_

List all the currently established client connections.

pub fn is_connected(&self, remote_addr: &SocketAddr) -> bool

Returns true if the client has a completely established WebRTC data channel connection and can send messages back and forth. Returns false for disconnected clients as well as those that are still starting up or are in the process of shutting down.

pub fn disconnect(&mut self, remote_addr: &SocketAddr)

Disconect the given client, does nothing if the client is not currently connected.

pub async fn send<'_, '_, '_>(
    &'_ mut self,
    message: &'_ [u8],
    message_type: MessageType,
    remote_addr: &'_ SocketAddr
) -> Result<(), SendError>

Send the given message to the given remote client, if they are connected.

The given message must be less than MAX_MESSAGE_LEN.

pub async fn recv<'_, '_>(&'_ mut self) -> Result<MessageResult<'_>, IoError>

Receive a WebRTC data channel message from any connected client.

Server::recv must be called for proper operation of the server, as it also handles background tasks such as responding to STUN packets and timing out existing sessions.

If the provided buffer is not large enough to hold the received message, the received message will be truncated, and the original length will be returned as part of MessageResult.