Struct Worker

pub struct Worker { /* private fields */ }

A worker represents a mediasoup C++ thread that runs on a single CPU core and handles Router instances.

Implementations

impl Worker

pub fn id(&self) -> WorkerId

Worker id.

pub fn worker_manager(&self) -> &WorkerManager

Worker manager to which worker belongs.

pub fn app_data(&self) -> &AppData

Custom application data.

pub fn closed(&self) -> bool

Whether the worker is closed.

pub async fn update_settings( &self, data: WorkerUpdateSettings, ) -> Result<(), RequestError>

Updates the worker settings in runtime. Just a subset of the worker settings can be updated.

pub async fn create_webrtc_server( &self, webrtc_server_options: WebRtcServerOptions, ) -> Result<WebRtcServer, CreateWebRtcServerError>

Create a WebRtcServer.

Worker will be kept alive as long as at least one WebRTC server instance is alive.

pub async fn create_router( &self, router_options: RouterOptions, ) -> Result<Router, CreateRouterError>

Create a Router.

Worker will be kept alive as long as at least one router instance is alive.

pub fn on_new_webrtc_server<F: Fn(&WebRtcServer) + Send + Sync + 'static>( &self, callback: F, ) -> HandlerId

Callback is called when a new WebRTC server is created.

pub fn on_new_router<F: Fn(&Router) + Send + Sync + 'static>( &self, callback: F, ) -> HandlerId

Callback is called when a new router is created.

pub fn on_dead<F: FnOnce(Result<(), ExitError>) + Send + Sync + 'static>( &self, callback: F, ) -> HandlerId

Callback is called when the worker thread unexpectedly dies.

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

Callback is called when the worker is closed for whatever reason.

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

Trait Implementations

impl Clone for Worker

fn clone(&self) -> Worker

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Worker

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

Formats the value using the given formatter.