Struct Session

pub struct Session { /* private fields */ }

A MoQ session, used to publish and/or subscribe to broadcasts.

A publisher will Self::publish tracks, or alternatively [Self::announce] and [Self::route] arbitrary paths. A subscriber will [Self::subscribe] to tracks, or alternatively use [Self::announced] to discover arbitrary paths.

Implementations

impl Session

pub async fn connect<T: Into<Session>>(session: T) -> Result<Self, Error>

Perform the MoQ handshake as a client.

pub async fn accept<T: Into<Session>>(session: T) -> Result<Self, Error>

Perform the MoQ handshake as a server

pub fn publish<T: ToString>(&mut self, path: T, broadcast: BroadcastConsumer)

Publish a broadcast, automatically announcing and serving it.

pub fn publish_prefix(&mut self, prefix: &str, broadcasts: OriginConsumer)

Publish all broadcasts from the given origin with a prefix.

pub fn publish_all(&mut self, broadcasts: OriginConsumer)

Publish all broadcasts from the given origin.

pub fn consume(&self, path: &str) -> BroadcastConsumer

Consume a broadcast, returning a handle that can request tracks.

No tracks flow over the network until BroadcastConsumer::subscribe is called.

pub fn consume_all(&self) -> OriginConsumer

Discover and consume all broadcasts.

No tracks flow over the network until BroadcastConsumer::subscribe is called.

pub fn consume_prefix<S: ToString>(&self, prefix: S) -> OriginConsumer

Discover and consume any broadcasts published by the remote matching a prefix.

No tracks flow over the network until BroadcastConsumer::subscribe is called.

pub fn consume_exact(&self, path: &str) -> OriginConsumer

Discover and consume a specific broadcast.

This is different from consume because it waits for an announcement. The returned OriginConsumer will ONLY announce a suffix=“”.

TODO: Make a special class for this.

pub fn close(self, err: Error)

Close the underlying WebTransport session.

pub async fn closed(&self) -> Error

Block until the WebTransport session is closed.

Trait Implementations

impl Clone for Session

fn clone(&self) -> Session

Returns a duplicate of the value.

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

Performs copy-assignment from source.