Struct libsip::SoftPhone

pub struct SoftPhone { /* fields omitted */ }

Simple SIP client for implementing softphones. Currently the only thing implemented is registration and sending text messages. The only other feature planned is an interface for sending & receiving calls.

Implementations

impl SoftPhone

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

Create a new SoftPhone client. local_uri is the SipUri that you listen on and account_uri is the uri of your SIP user account.

pub fn registry(&self) -> &RegistrationManager

Return a reference to the sip registration manager.

pub fn registry_mut(&mut self) -> &mut RegistrationManager

Return a mutable reference tp the sip registration manager.

pub fn messaging(&self) -> &MessageWriter

Return a reference to the message writer.

pub fn messaging_mut(&mut self) -> &mut MessageWriter

Return a mutable reference to the MessageWriter.

pub fn invite(&self) -> &InviteWriter

Return a reference to the invite writer.

pub fn invite_mut(&mut self) -> &mut InviteWriter

Return a mutable reference to the InviteWriter.

pub fn header_cfg(&self) -> &HeaderWriteConfig

Return a reference to the used HeaderWriteConfig.

pub fn header_cfg_mut(&mut self) -> &mut HeaderWriteConfig

Return a mutable reference to the used HeaderWriteConfig.

pub fn get_register_request(&mut self) -> IoResult<SipMessage>

Simple pass through method to get a registration request.

pub fn set_register_challenge(&mut self, c: SipMessage) -> IoResult<()>

Set the received auth challenge request.

pub fn write_message(&mut self, b: Vec<u8>, uri: Uri) -> IoResult<SipMessage>

Send a new Message to uri.

pub fn send_invite(&mut self, body: Vec<u8>, uri: Uri) -> IoResult<SipMessage>

Send a new Invite Request to uri.

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

Give the softphone a received call, returns the ringing response to be sent.

pub fn get_accept_request(
    &mut self,
    body: Vec<u8>,
    call: &str
) -> IoResult<SipMessage>

Get a SIP Message that will accept a previously recieved invitation.

pub fn get_bye_request(&mut self, call: &str) -> IoResult<SipMessage>

Get a SIP message that will close a previously received invitation.

pub fn get_cancel_request(
    &mut self,
    call: &str
) -> IoResult<(SipMessage, SipMessage)>

Get the messages required to cancel a invitation.