Struct SipAgent 

pub struct SipAgent { /* private fields */ }

A SIP user agent server: binds a UDP SIP port and yields incoming calls.

Implementations

impl SipAgent

pub async fn bind(addr: SocketAddr) -> Result<SipAgent, SipError>

Bind the SIP signalling port (conventionally 5060/udp) and start the endpoint’s serve loop in the background.

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

Wait for the next incoming call. In-dialog requests (BYE, re-INVITE, ACK) and non-call methods are handled internally; only new INVITEs surface. Returns None once the agent is shut down.

pub fn sip_port(&self) -> u16

The SIP port actually bound (useful with port 0).

pub fn shutdown(&self)

Stop the endpoint and every call it produced.

pub async fn register( &self, account: SipAccount, ) -> Result<SipRegistration, SipError>

Register this agent with a registrar, so calls to the account’s address reach it.

The first REGISTER (answering a digest challenge with the account’s credentials) happens before this returns, so a wrong password or an unreachable registrar fails here. After that, the returned SipRegistration refreshes the binding at three quarters of the granted lifetime, and retries after a failure, until it is unregistered or the agent shuts down.

let agent = SipAgent::bind("0.0.0.0:5060".parse()?).await?;
let registration = agent
    .register(SipAccount::new("sip:pbx.example.com", "agent", "secret"))
    .await?;
// ... take calls with agent.next_call() ...
registration.unregister().await?;