Struct ServiceRoute 

pub struct ServiceRoute(pub Vec<Address>);

The proxies a registrar says this UA’s own requests must traverse (RFC 3608).

The opposite direction from PathSet, and — unlike Path — this one is the UA’s to act on. RFC 3608 §6: the route “applies only to requests originating in the user agent”, and §6.1 has the UA “use the content of the Service-Route header field as a preloaded Route header field in outgoing initial requests”. Without it, a request sipx sends goes straight at the destination and arrives at a proxy holding no state for the registration it belongs to.

Order is normative: §6.1 requires a UA that exercises the route to “preserve the order” the values arrived in.

Tuple Fields

0: Vec<Address>

Implementations

impl ServiceRoute

pub fn hops(&self) -> &[Address]

The proxies, in the order the registrar listed them — which is the order to traverse.

pub fn is_empty(&self) -> bool

Whether the registrar dictated no route at all.

pub fn rendered(&self) -> Vec<String>

Each hop rendered as a Route header value, in order.

This is the form to preload: Route: <sip:proxy.example;lr>, one per hop.

pub fn from_response(response: &Response) -> Self

Read the service route out of a REGISTER response.

Absent means empty, and empty means clear. RFC 3608 §6.1 says the stored value “is updated according to the Service-Route header field of the latest 200 class response”, and that “if there is no Service-Route header field in the response, the UA clears any service route for that address-of-record previously stored”. Both rules are the same rule — replace unconditionally — which is why this returns an empty set rather than an Option a caller could mistake for “leave what you had”.

pub fn hops_without_loose_routing(&self) -> Vec<String>

The hops the registrar sent without the ;lr parameter RFC 3608 §5 requires.

§5: values “MUST include the loose-routing indicator parameter ;lr”. A hop without it asks for RFC 2543 strict routing, where each proxy rewrites the Request-URI — a mechanism sipx does not implement and would be wrong to pretend to. Reported rather than rejected: the offending party is the registrar, the request will still reach the proxy named, and a UA that discarded the whole route set over a missing parameter would be unroutable for a reason its operator could not see.

lr is a URI parameter — inside the angle brackets — not a header parameter after them. Looking for it in the wrong list finds nothing and reports every hop, which is how this method was wrong the first time it was written.

Trait Implementations

impl Clone for ServiceRoute

fn clone(&self) -> ServiceRoute

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ServiceRoute

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

Formats the value using the given formatter.

impl Default for ServiceRoute

fn default() -> ServiceRoute

Returns the “default value” for a type.

impl PartialEq for ServiceRoute

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for ServiceRoute