SIP types¶
Small value objects that flow through the scripting API: parsed URIs, contact bindings, the captured inbound flow, and the action record the test harness uses to report what a handler did.
SipUri¶
A parsed SIP / SIPS / tel URI. Reachable via request.ruri, request.from_uri,
request.to_uri, and Contact.uri parsing.
A parsed SIP or SIPS URI (e.g. sip:alice@example.com:5060).
At runtime this is backed by the Rust PySipUri class. The mock
version is a plain dataclass with the same properties.
Examples::
uri = SipUri(user="alice", host="example.com")
assert str(uri) == "sip:alice@example.com"
uri = SipUri(scheme="sips", host="proxy.example.com", port=5061)
assert str(uri) == "sips:proxy.example.com:5061"
class-attribute
instance-attribute
¶
User part of the URI (e.g. "alice"). None for server URIs.
class-attribute
instance-attribute
¶
Host or domain (e.g. "example.com", "10.0.0.1").
class-attribute
instance-attribute
¶
Port number. None means default (5060 for SIP, 5061 for SIPS).
property
¶
True if the host matches one of the locally configured domains.
In the mock, set via SipUri._is_local = True or via the test
harness local_domains parameter.
Contact¶
A registered contact binding returned by registrar.lookup(...).
A registered contact binding returned by registrar.lookup().
Attributes:
| Name | Type | Description |
|---|---|---|
uri |
str
|
The contact URI string (e.g. |
q |
float
|
Quality value between 0.0 and 1.0 (higher = preferred). |
expires |
int
|
Seconds remaining until this binding expires. |
class-attribute
instance-attribute
¶
Quality value (0.0–1.0). Higher values are preferred. Default is 1.0 per RFC 3261.
class-attribute
instance-attribute
¶
Seconds remaining until this contact binding expires.
class-attribute
instance-attribute
¶
RFC 3327 Path headers stored with this binding. Use as Route headers when routing terminating requests to this contact.
class-attribute
instance-attribute
¶
Stable identity of the siphon instance that originally accepted the
REGISTER (typically the StatefulSet pod name). None for legacy
bindings or deployments that do not configure server.instance_id.
class-attribute
instance-attribute
¶
Boot-time epoch UUID of the process that accepted the REGISTER.
Combined with :attr:instance_id, distinguishes successive runs of the
same logical replica.
class-attribute
instance-attribute
¶
True when the binding's (instance_id, instance_epoch) matches
the current siphon process — i.e. this process accepted the REGISTER.
Useful for graceful-shutdown deregister and NAT keepalive ownership.
class-attribute
instance-attribute
¶
Opaque proxy-side token attached at REGISTER time via
registrar.save(flow_token=...). None for non-P-CSCF
bindings.
class-attribute
instance-attribute
¶
Captured inbound flow (Flow view). Pass to
request.relay(flow=...) / request.fork(contacts) /
call.dial(flow=...) for RFC 5626 §5.3 connection reuse — the only
way to reach a WebSocket UE (RFC 7118 §5). Populated for any binding
this process accepted (no flow_token= required); None only for a
binding restored cross-instance whose local listener / connection id
aren't available here. Guard on :attr:is_local before routing over
it.
class-attribute
instance-attribute
¶
Contact-header parameters preserved from the originating REGISTER
(or 3PR 200 OK), excluding tag, q, expires,
+sip.instance, and reg-id which are broken out into other
fields. Each entry is a (name, value) tuple — value is
None for flag parameters (e.g. +g.3gpp.smsip) and a string
for valued parameters (e.g. +g.3gpp.icsi-ref="urn:...").
Surfaced verbatim by :func:registrar.reginfo_xml as
<unknown-param> children per RFC 3680 §5.3.2 so watchers see the
same capability advertisement the registrar received.
class-attribute
instance-attribute
¶
"ue" (UE-side binding from a REGISTER — the default and the
only contacts returned by :func:registrar.lookup) or "as"
(application-server capability record captured from a 3PR 200 OK
via :func:registrar.save_as_contact). AS contacts surface in
reg-event NOTIFY bodies (TS 24.229 §5.4.2.1.2) but are excluded
from routing lookups.
Flow¶
An opaque view of the inbound flow captured at REGISTER time, used for Path-token MT routing.
Opaque view of an inbound flow captured at REGISTER time.
Returned by :attr:Contact.flow and :attr:Request.flow. Pass back
to :meth:Request.relay (flow= kwarg) to send a request over the
same listener that received the REGISTER — bypassing DNS resolution
of the Request-URI. Used by P-CSCF MT routing (RFC 3327 §5 /
TS 24.229 §5.2.7.2) where the UE's Contact URI is unreachable
(NAT, IPSec) and the only path back is the captured flow.
Treat as opaque: scripts read :attr:is_alive for defensive checks
but should not depend on the internal field shapes.
class-attribute
instance-attribute
¶
Lowercase transport name: "udp", "tcp", "tls", "ws",
or "wss".
class-attribute
instance-attribute
¶
String form of the captured UE source address ("ip:port").
class-attribute
instance-attribute
¶
String form of the captured listener local address — load-bearing for IPSec sec-agree where the protected port pair must be preserved (3GPP TS 33.203 §7.4).
property
¶
Whether the flow is still usable.
For UDP, always True: the listener socket survives any
individual exchange. For stream transports (TCP/TLS/WS/WSS), the
real implementation returns True only while the exact accepted
connection that delivered the REGISTER is still open on this process
— a real lookup against the unified stream-connection registry (see
PyFlow.is_alive in src/script/api/registrar.rs). A UE that
reconnected, or whose socket closed, reports False.
The mock always returns True (no live connections to track).
Action¶
The record the test harness captures for each action a handler takes (reply, relay, fork, reject, …). Scripts do not create these; assertions read them.
Records a single action taken by a handler (reply, relay, fork, etc.).
Used by the test harness to capture what a script did in response to a SIP message, so you can assert on it.
instance-attribute
¶
Action type: "reply", "relay", "fork", "reject",
"dial", "terminate", "record_route", "silent_drop".
class-attribute
instance-attribute
¶
For reply / reject — the SIP status code (e.g. 200, 404).
class-attribute
instance-attribute
¶
For reply / reject — the reason phrase (e.g. "OK").
class-attribute
instance-attribute
¶
For relay — the explicit next-hop URI, or None for default.
class-attribute
instance-attribute
¶
For fork — list of target URIs.
class-attribute
instance-attribute
¶
For fork — "parallel" or "sequential".
class-attribute
instance-attribute
¶
For dial / fork — timeout in seconds.
class-attribute
instance-attribute
¶
Headers that were set/modified before this action.
class-attribute
instance-attribute
¶
Headers that were removed before this action.
class-attribute
instance-attribute
¶
Additional action-specific data (e.g. session timer params, SRS URI).
class-attribute
instance-attribute
¶
For reply — RFC 3262 reliable provisional flag (Require: 100rel).