Struct SipAgent 

pub struct SipAgent { /* private fields */ }

A SIP user agent for one trunk. See the module docs.

Implementations

impl SipAgent

pub async fn start(cfg: SipConfig) -> Result<Self, FlowcatError>

Start the agent: bind the SIP UDP transport, launch the endpoint serve loop + incoming-INVITE pump (+ registration loop if a password is set).

Does not block on registration; call SipAgent::register to await the first REGISTER result, or just let the background loop keep the binding fresh. Returns once the transport is bound and tasks are spawned.

pub async fn register(&self) -> Result<u32, FlowcatError>

Send one REGISTER now and await its result (does not start the refresh loop — that runs from SipAgent::start). Useful at bring-up to fail fast if the trunk credentials are wrong. Returns the registration expiry secs.

pub async fn next_inbound(&self) -> Option<InboundInvite>

Yield the next inbound INVITE, or None once the agent is shut down.

pub async fn originate( &self, to_e164: &str, caller_id: Option<&str>, ) -> Result<SipTransport, FlowcatError>

Originate an outbound call to to_e164 from caller_id (overrides the configured caller-id when given). Awaits the 200 OK and returns the media transport over the negotiated G.711.

pub fn shutdown(&self)

Tear down the agent: cancels the endpoint serve loop + all tasks.

Trait Implementations

impl Drop for SipAgent

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.