Struct SipManager

pub struct SipManager { /* private fields */ }

Represents an SIP session. SipManager is used to instantiate the SIP connection make / receive calls.

Calling start connects to the SIP Server and starts listening and handling SIP messages.

Examples

 use std::net::SocketAddr;
 use std::str::FromStr;
 use simple_sip_rs::config::Config;
 use simple_sip_rs::manager::SipManager;

 async fn start_sip() {
    let config = Config {
        server_addr: SocketAddr::from_str("192.168.1.100:5060").unwrap(),
        own_addr: SocketAddr::from_str("192.168.1.2").unwrap(),
        username: "username".to_string(),
        password: "password".to_string(),
        rtp_port_start: 20480,
        rtp_port_end: 20490,
    };


    let mut sip_manager = SipManager::from_config(config).await.unwrap();
    sip_manager.start().await.unwrap();

    let outgoing_call = sip_manager.call("1000".to_string());
}

Implementations

impl SipManager

pub async fn from_config(config: Config) -> Result<Self>

Create SipManager from the config

pub async fn start(&mut self) -> Result<()>

Starts the registration on the SIP server and starts listening to SIP messages. This function is non-blocking

Errors

This function will return an error in the following cases:

• Failed to establish the underlying TCP connection
• Failed to authenticate

pub fn stop(&mut self)

Stops the underlying SIP socket. This effectively disconnects you from the server.

pub async fn is_running(&self) -> bool

Checks if the connection is alive.

pub fn take_incoming_call_receiver(&mut self) -> Option<IncomingCallReceiver>

Takes the incoming call receiver. This is useful if you want to handle incoming calls in another task / thread.

Will return None if the receiver was already taken.

pub fn give_incoming_call_receiver(&mut self, receiver: IncomingCallReceiver)

Give back the incoming call receiver.

pub async fn recv_incoming_call(&mut self) -> Result<Option<IncomingCall>>

Get the next incoming call in the queue.

Errors

Errors if the receiver was previously taken.

pub async fn call(&self, to: String) -> Result<OutgoingCall>

Initiate a call to the given destination.

Arguments

• to: Extension number to call. Ex: "1000".

Errors

This function will return an error in the following cases:

• You are not connected to the server
• Failure to send the Invite message