Struct libsip::RegistrationManager

pub struct RegistrationManager { /* fields omitted */ }

Handle's the SIP registration process. This structure is designed to handle the authentication process from a SoftPhone's point of view.

Currently only Digest auth authentication is implemented.

Implementations

impl RegistrationManager

pub fn new(account_uri: Uri, local_uri: Uri) -> RegistrationManager

Create a new Registration Manager typically this will happen once in a program's lifecycle. account_uri is the sip uri used to authenticate with and local_uri is the sip uri of the listening socket.

pub fn username<S: Into<String>>(&mut self, s: S)

Set the username used in the authentication process.

pub fn password<S: Into<String>>(&mut self, p: S)

Set the password used in the authentication process.

pub fn get_request(&mut self, cfg: &HeaderWriteConfig) -> IoResult<SipMessage>

Get the register request. if this method is called before set_challenge then no authentication header will be set, if called after set_challenge then the Authorization header will be set.

pub fn set_challenge(&mut self, msg: SipMessage) -> IoResult<()>

After the first register request is sent. pass the received sip response to this function to perform compute the hashed password.

pub fn expires(&self) -> u32

Retreive the expires header value.

pub fn cseq(&self) -> u32

Retreive the current cseq counter.

pub fn via_header(&self) -> Header

Retreive the via header being used to represent the local listening socket.

Trait Implementations

impl Clone for RegistrationManager

fn clone(&self) -> RegistrationManager

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RegistrationManager

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

Formats the value using the given formatter.

impl PartialEq<RegistrationManager> for RegistrationManager

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for RegistrationManager