Struct CallbackPeerControl 

pub struct CallbackPeerControl { /* private fields */ }

Cloneable command handle for a running CallbackPeer.

Implementations

impl CallbackPeerControl

pub fn register( &self, registrar: impl Into<String>, username: impl Into<String>, password: impl Into<String>, ) -> RegisterBuilder

Begin building an outbound REGISTER from this peer.

Returns a RegisterBuilder — chain .with_expires(..), .with_from_uri(..), .with_contact_uri(..), .with_credentials(..) etc. and finish with .send().await.

pub fn register_account(&self, account: &SipAccount) -> RegisterBuilder

Begin building an outbound REGISTER from a shared SIP account.

pub async fn is_registered(&self, handle: &RegistrationHandle) -> Result<bool>

Query whether a registration handle is currently registered.

This is a coarse boolean. Use coordinator and UnifiedCoordinator::registration_info for lifecycle metadata.

Examples

let active = control.is_registered(&handle).await?;

pub async fn unregister(&self, handle: &RegistrationHandle) -> Result<()>

Unregister.

Returns after the state machine accepts the unregister request. Use UnifiedCoordinator::unregister_and_wait through coordinator for deterministic registrar confirmation.

Examples

control.unregister(&handle).await?;

pub async fn hangup(&self, handle: &SessionHandle) -> Result<()>

Hang up or cancel a call and wait until rvoip-sip has accepted the request.

This uses the same SIP teardown semantics as SessionHandle::hangup: BYE for established calls, CANCEL for ringing/early outbound calls, and delayed CANCEL intent before the first provisional response. Callback handlers observe terminal completion through on_call_ended, on_call_failed, or on_call_cancelled.

Examples

control.hangup(&call).await?;

pub fn shutdown(&self)

Signal the owning CallbackPeer event loop to stop.

This is a stop signal for the event loop. For deterministic graceful unregister, call UnifiedCoordinator::shutdown_gracefully through coordinator.

Examples

control.shutdown();

pub fn coordinator(&self) -> &Arc<UnifiedCoordinator>

Access the underlying coordinator for advanced operations.

This accessor is intentionally trivial and returns the shared UnifiedCoordinator handle.

pub fn invite(&self, target: impl Into<String>) -> OutboundCallBuilder

Begin building an outbound INVITE from this peer’s configured local_uri. Returns an OutboundCallBuilder.

Trait Implementations

impl Clone for CallbackPeerControl

fn clone(&self) -> CallbackPeerControl

Returns a duplicate of the value.

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

Performs copy-assignment from source.