Skip to main content

Module event

Module event 

Source
Expand description

Subscriptions and notifications, as decisions (RFC 6665).

The pure half of the event framework: what a Subscription-State says, when a subscription is over, what a refresh does to its expiry, and whether a package is one this side serves. No dialog, no clock, no socket — those belong to whoever drives it.

sipx has had exactly one subscription since S-9: the implicit one a REFER creates. That one works and is not a framework. What makes this a framework is that a package is a name and a body type, and everything else — establishing, refreshing, expiring, terminating, refusing an unknown one — is the same whichever package it is.

Structs§

Packages
The packages a notifier serves, by Event name.
Subscription
A parsed Subscription-State (RFC 6665 §4.1.3).

Enums§

Reason
Why a subscription ended (RFC 6665 §4.1.3).
State
The state of a subscription, as a Subscription-State header says it (RFC 6665 §4.1.3).

Constants§

BAD_EVENT
The status a SUBSCRIBE naming an unserved package is refused with (RFC 6665 §4.2.1.1).

Functions§

granted_expiry
The expiry a notifier grants for a requested one (RFC 6665 §4.2.1.1).
is_unsubscribe
Whether a SUBSCRIBE is asking to end the subscription rather than to have one (§3.1.1).