Struct Dispatcher 

pub struct Dispatcher { /* private fields */ }

One endpoint’s incoming requests, routed to any number of concurrent calls.

Owns the endpoint’s Receiver<Incoming>, which is the whole reason it can promise anything: there is exactly one of those, so anything else reading it would be reading requests this cannot then route.

Implementations

impl Dispatcher

pub fn new(endpoint: Handle, incoming: Receiver<Incoming>) -> Self

Take over an endpoint’s incoming requests, with the default per-call queue depth.

pub fn with_queue( endpoint: Handle, incoming: Receiver<Incoming>, queue: usize, ) -> Self

The same, with a per-call queue depth of your own.

A depth of zero is raised to one: an unbuffered channel would shed every request that arrived while the call was between recv calls, which is most of them.

pub fn with_identity(self, identity: InboundIdentityPolicy) -> Self

Verify new inbound INVITEs before they become answerable application invitations.

A verification failure is sent on the INVITE transaction with its RFC 8224 status and the request is not surfaced. With no selected policy, dispatch remains wire-compatible and performs no credential acquisition or time read.

pub fn with_notifier(self, notifier: Notifier) -> Self

Serve inbound RFC 6665 SUBSCRIBE requests through this bounded notifier.

pub fn with_event_subscriptions(self, subscriptions: EventSubscriptions) -> Self

Route inbound NOTIFY requests to a bounded outbound event-subscription client.

pub fn with_publications(self, publications: Publications) -> Self

Serve inbound PUBLISH and attach outbound publication transactions to this endpoint.

pub fn calls(&self) -> Calls

A handle for registering calls this dispatcher did not itself surface.

pub fn register(&self, dialog: &Dialog) -> Receiver<Incoming>

Route this dialog’s requests to the returned inbox — Calls::register, for an application that holds the dispatcher directly.

pub fn counts(&self) -> DispatchCounts

What has been refused, shed or left unplaced.

pub fn begin_drain(&mut self)

Atomically close new-dialog admission for this dispatcher and its transport endpoint.

Existing routes and transactions remain live. Calling this more than once is harmless.

pub const fn is_draining(&self) -> bool

Whether new-dialog admission has been closed.

pub async fn drain_progress(&self) -> Result<DrainProgress>

Observe the two completion dimensions used by Self::drain.

pub async fn drain(&mut self, within: Duration) -> Result<DrainReport>

Close admission, drive existing dialogs and transactions, and stop the endpoint.

Completion is event-driven: route receiver closure and the endpoint’s transaction-terminal barrier. within only bounds failure. At expiry every remaining route is closed, the live counts are logged and returned, and the ordinary endpoint shutdown path cancels and joins transport-owned tasks.

pub async fn next(&mut self) -> Option<Dispatched>

The next thing the dispatcher cannot place itself.

Routes everything else on the way, so this must be called in a loop for a dispatcher to do its job at all — the ACKs and BYEs of every call it has already handed out move only while it is being polled. None once the endpoint has shut down.

Trait Implementations

impl Debug for Dispatcher

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

Formats the value using the given formatter.