Struct Subscriptions 

pub struct Subscriptions { /* private fields */ }

The subscriptions one notifier is serving.

Implementations

impl Subscriptions

pub fn new(packages: Packages, policy_maximum: Duration) -> Self

A notifier serving these packages, granting at most this long.

pub fn with_capacity(self, capacity: usize) -> Self

Apply a finite concurrent-subscription bound.

Zero is raised to one: a notifier configured with no capacity could advertise packages but never serve one, which is almost certainly a configuration mistake rather than policy.

pub fn capacity(&self) -> usize

The concurrent-subscription bound.

pub fn packages(&self) -> &Packages

The packages served, for an Allow-Events header.

pub fn active(&self) -> usize

How many subscriptions are live.

pub fn all(&self) -> &[Served]

Every subscription being served, terminated ones included until they are swept.

pub fn on_subscribe(&mut self, request: &Request, now: u64) -> Answer

Answer a SUBSCRIBE.

pub fn terminate(&mut self, id: &Id, reason: Reason) -> Option<Subscription>

End a subscription deliberately.

Returns the state to put in the terminating NOTIFY, or None if there was nothing to end.

pub fn expire(&mut self, now: u64) -> Vec<Id>

Terminate everything that has run out of time, and say which (§4.1.3, reason=timeout).

pub fn notify_state(&self, id: &Id, now: u64) -> Option<Subscription>

The Subscription-State a NOTIFY for this subscription should carry.

None when the subscription is terminated or unknown — which is what stops a terminated subscription being notified. A notifier that produced an active state here for a subscription it had ended would resurrect it, and the subscriber would go on believing it was watching something.

pub fn sweep(&mut self) -> usize

Forget terminated subscriptions.

Separate from terminating them, and deliberately so: a terminated subscription has to stay findable long enough for its terminating NOTIFY to be sent and for a crossing refresh to be refused rather than treated as new.

Trait Implementations

impl Debug for Subscriptions

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

Formats the value using the given formatter.