Struct SoapClient 

pub struct SoapClient { /* private fields */ }

A minimal SOAP client for UPnP device communication

Uses Arc internally for efficient sharing of the underlying HTTP client and connection pool across multiple instances.

Implementations

impl SoapClient

pub fn get() -> &'static Self

Get the global shared SOAP client instance

This provides a singleton-like pattern for maximum resource efficiency. All clients returned by this method share the same underlying HTTP agent and connection pool, reducing memory usage and improving performance.

pub fn with_agent(agent: Arc<Agent>) -> Self

Create a SOAP client with a custom agent (for advanced use cases only)

Most applications should use SoapClient::get() instead for better resource efficiency. This method is provided for cases where custom timeout values or other HTTP client configuration is needed.

pub fn new() -> Self

👎Deprecated since 0.1.0:

Use SoapClient::get() for shared resources

Create a new SOAP client with default configuration

DEPRECATED: Use SoapClient::get() instead for better resource efficiency. This method creates a separate HTTP agent instance, which wastes resources when multiple SOAP clients are used.

pub fn call( &self, ip: &str, endpoint: &str, service_uri: &str, action: &str, payload: &str, ) -> Result<Element, SoapError>

Send a SOAP request and return the parsed response element

pub fn subscribe( &self, ip: &str, port: u16, event_endpoint: &str, callback_url: &str, timeout_seconds: u32, ) -> Result<SubscriptionResponse, SoapError>

Subscribe to UPnP events for a specific service endpoint

Arguments

• ip - Device IP address
• port - Device port (typically 1400)
• event_endpoint - Event endpoint path (e.g., “MediaRenderer/AVTransport/Event”)
• callback_url - URL where events should be sent
• timeout_seconds - Requested subscription timeout in seconds

Returns

A SubscriptionResponse containing the SID and actual timeout

pub fn renew_subscription( &self, ip: &str, port: u16, event_endpoint: &str, sid: &str, timeout_seconds: u32, ) -> Result<u32, SoapError>

Renew an existing UPnP subscription

Arguments

• ip - Device IP address
• port - Device port (typically 1400)
• event_endpoint - Event endpoint path
• sid - Subscription ID to renew
• timeout_seconds - Requested renewal timeout in seconds

Returns

The actual timeout granted by the device

pub fn unsubscribe( &self, ip: &str, port: u16, event_endpoint: &str, sid: &str, ) -> Result<(), SoapError>

Unsubscribe from UPnP events

Arguments

• ip - Device IP address
• port - Device port (typically 1400)
• event_endpoint - Event endpoint path
• sid - Subscription ID to cancel

Trait Implementations

impl Clone for SoapClient

fn clone(&self) -> SoapClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SoapClient

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SoapClient

fn default() -> Self

Returns the “default value” for a type.