Struct Peering 

pub struct Peering { /* private fields */ }

Our short-term credentials and the peer’s, and the two usernames they make (spec §11.2).

This type exists for one reason: the direction. A check sipx sends carries <peer-ufrag>:<our-ufrag> and is keyed with the peer’s password; a check sipx receives carries <our-ufrag>:<peer-ufrag> and is keyed with ours, as is the response sipx sends back to it. Reverse the two and every check sipx sends is rejected for a bad credential and every check it receives goes unanswered — which on the wire is indistinguishable from a blocked path, so it gets diagnosed as a network fault and not as the four transposed characters it is. Naming the four values rather than formatting a username at each call site is what makes the mistake reviewable.

Implementations

impl Peering

pub const fn new(local: Credentials, remote: Credentials) -> Self

Pair our credentials with the peer’s.

pub const fn local(&self) -> &Credentials

Our a=ice-ufrag and a=ice-pwd.

pub const fn remote(&self) -> &Credentials

The peer’s.

pub fn outbound_username(&self) -> String

The USERNAME on a check sipx sends: <peer-ufrag>:<our-ufrag>.

pub fn outbound_key(&self) -> &str

The key for a check sipx sends, and for the response it expects back: the peer’s password.

pub fn inbound_username(&self) -> String

The USERNAME a check sipx receives must carry: <our-ufrag>:<peer-ufrag>.

pub fn inbound_key(&self) -> &str

The key for a check sipx receives, and for the response sipx sends to it: our password.

Trait Implementations

impl Clone for Peering

fn clone(&self) -> Peering

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Peering

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

Formats the value using the given formatter.

impl PartialEq for Peering

fn eq(&self, other: &Peering) -> 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 Peering

impl StructuralPartialEq for Peering