Struct matchbox_socket::WebRtcSocket

source ·

pub struct WebRtcSocket<C: ChannelPlurality = SingleChannel> { /* private fields */ }

Expand description

Contains a set of WebRtcChannels and connection metadata.

Implementations§

source §

impl WebRtcSocket

source

pub fn builder(room_url: impl Into<String>) -> WebRtcSocketBuilder

Creates a new builder for a connection to a given room with a given number of re-connection attempts.

You must add at least one channel with WebRtcSocketBuilder::add_channel before you can build the WebRtcSocket

source

pub fn new_unreliable( room_url: impl Into<String> ) -> (WebRtcSocket<SingleChannel>, MessageLoopFuture)

Creates a WebRtcSocket and the corresponding MessageLoopFuture for a socket with a single unreliable channel.

The returned MessageLoopFuture should be awaited in order for messages to be sent and received.

Please use the WebRtcSocketBuilder to create non-trivial sockets.

source

pub fn new_reliable( room_url: impl Into<String> ) -> (WebRtcSocket<SingleChannel>, MessageLoopFuture)

Creates a WebRtcSocket and the corresponding MessageLoopFuture for a socket with a single reliable channel.

The returned MessageLoopFuture should be awaited in order for messages to be sent and received.

Please use the WebRtcSocketBuilder to create non-trivial sockets.

source §

impl<C: ChannelPlurality> WebRtcSocket<C>

source

pub fn close(&mut self)

Close this socket, disconnecting all channels.

source

pub fn update_peers(&mut self) -> Vec<(PeerId, PeerState)>

Handle peers connecting or disconnecting

Constructed using WebRtcSocketBuilder.

Update the set of peers used by WebRtcSocket::connected_peers and WebRtcSocket::disconnected_peers.

Returns the peers that connected or disconnected since the last time this method was called.

§Panics

Will panic if the socket future has been dropped.

WebRtcSocket::try_update_peers is the equivalent method that will instead return a Result.

source

pub fn try_update_peers( &mut self ) -> Result<Vec<(PeerId, PeerState)>, ChannelError>

Similar to WebRtcSocket::update_peers. Will instead return a Result::Err if the socket is closed.

source

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

Returns an iterator of the ids of the connected peers.

Note: You have to call WebRtcSocket::update_peers for this list to be accurate.

source

pub fn disconnected_peers(&self) -> impl Iterator<Item = &PeerId>

Returns an iterator of the ids of peers that are no longer connected.

Note: You have to call WebRtcSocket::update_peers for this list to be accurate.

source

pub fn id(&mut self) -> Option<PeerId>

Returns the id of this peer, this may be None if an id has not yet been assigned by the server.

source

pub fn channel(&self, channel: usize) -> &WebRtcChannel

Gets an immutable reference to the WebRtcChannel of a given id.

use matchbox_socket::*;

let (mut socket, message_loop) = WebRtcSocketBuilder::new("wss://example.invalid/")
    .add_channel(ChannelConfig::reliable())
    .add_channel(ChannelConfig::unreliable())
    .build();
let is_closed = socket.channel(0).is_closed();

§Panics

will panic if the channel cannot be found.

source

pub fn channel_mut(&mut self, channel: usize) -> &mut WebRtcChannel

Gets a mutable reference to the WebRtcChannel of a given id.

use matchbox_socket::*;

let (mut socket, message_loop) = WebRtcSocketBuilder::new("wss://example.invalid/")
    .add_channel(ChannelConfig::reliable())
    .add_channel(ChannelConfig::unreliable())
    .build();
let reliable_channel_messages = socket.channel_mut(0).receive();

§Panics

will panic if the channel cannot be found.

source

pub fn get_channel( &self, channel: usize ) -> Result<&WebRtcChannel, ChannelError>

Gets an immutable reference to the WebRtcChannel of a given id.

Returns an error if the channel was not found.

use matchbox_socket::*;

let (mut socket, message_loop) = WebRtcSocketBuilder::new("wss://example.invalid/")
    .add_channel(ChannelConfig::reliable())
    .add_channel(ChannelConfig::unreliable())
    .build();
let is_closed = socket.get_channel(0).unwrap().is_closed();

source

pub fn get_channel_mut( &mut self, channel: usize ) -> Result<&mut WebRtcChannel, ChannelError>

Gets a mutable reference to the WebRtcChannel of a given id.

Returns an error if the channel was not found.

use matchbox_socket::*;

let (mut socket, message_loop) = WebRtcSocketBuilder::new("wss://example.invalid/")
    .add_channel(ChannelConfig::reliable())
    .add_channel(ChannelConfig::unreliable())
    .build();
let reliable_channel_messages = socket.get_channel_mut(0).unwrap().receive();

source

pub fn take_channel( &mut self, channel: usize ) -> Result<WebRtcChannel, ChannelError>

Takes the WebRtcChannel of a given id.

use matchbox_socket::*;

let (mut socket, message_loop) = WebRtcSocketBuilder::new("wss://example.invalid/")
    .add_channel(ChannelConfig::reliable())
    .add_channel(ChannelConfig::unreliable())
    .build();
let reliable_channel = socket.take_channel(0).unwrap();
let unreliable_channel = socket.take_channel(1).unwrap();