mediasoup::webrtc_server

Struct WebRtcServer

Source
pub struct WebRtcServer { /* private fields */ }
Expand description

A WebRTC server brings the ability to listen on a single UDP/TCP port for multiple WebRtcTransports.

A WebRTC server exists within the context of a Worker, meaning that if your app launches N workers it also needs to create N WebRTC servers listening on different ports (to not collide). The WebRTC transport implementation of mediasoup is ICE Lite, meaning that it does not initiate ICE connections but expects ICE Binding Requests from endpoints.

Implementations§

Source§

impl WebRtcServer

Source

pub fn id(&self) -> WebRtcServerId

Router id.

Source

pub fn worker(&self) -> &Worker

Worker to which WebRTC server belongs.

Source

pub fn app_data(&self) -> &AppData

Custom application data.

Source

pub fn closed(&self) -> bool

Whether WebRTC server is closed.

Source

pub fn on_worker_close<F: FnOnce() + Send + 'static>( &self, callback: F, ) -> HandlerId

Callback is called when the worker this WebRTC server belongs to is closed for whatever reason. The WebRtc server itself is also closed. A on_webrtc_server_close callbacks are triggered in all relevant WebRTC transports.

Source

pub fn on_new_webrtc_transport<F>(&self, callback: F) -> HandlerId
where F: Fn(&WebRtcTransport) + Send + 'static,

Callback is called when new WebRtcTransport is added that uses this WebRTC server.

Source

pub fn on_close<F: FnOnce() + Send + 'static>(&self, callback: F) -> HandlerId

Callback is called when the WebRTC server is closed for whatever reason.

NOTE: Callback will be called in place if WebRTC server is already closed.

Trait Implementations§

Source§

impl Clone for WebRtcServer

Source§

fn clone(&self) -> WebRtcServer

Returns a copy of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for WebRtcServer

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.