Struct rupnp::Service

pub struct Service { /* fields omitted */ }

A UPnP Service is the description of endpoints on a device for performing actions and reading the service definition. For a list of actions and state variables the service provides, take a look at scpd.

Methods

impl Service

pub fn service_type(&self) -> &URN

Returns the URN of this service.

pub fn service_id(&self) -> &str

Returns the Service Identifier.

pub async fn scpd<'_, '_>(&'_ self, url: &'_ Uri) -> Result<SCPD, Error>

Fetches the SCPD of this service.

pub async fn action<'_, '_, '_, '_>(
    &'_ self,
    url: &'_ Uri,
    action: &'_ str,
    payload: &'_ str
) -> Result<HashMap<String, String>, Error>

Execute some UPnP Action on this service. The URL is usually obtained by the device this service was found on. The payload is xml-formatted data.

Example usage:

use upnp::ssdp::URN;
use upnp::Device;

let urn = URN::service("schemas-upnp-org", "RenderingControl", 1);

let device = Device::from_url( some_url ).await?;
let service = device.find_service(&urn)
    .expect("service exists");

let args = "<InstanceID>0</InstanceID><Channel>Master</Channel>";
let response = service.action(device.url(), "GetVolume", args).await?;

let volume = response
    .get("CurrentVolume")
    .expect("exists");

println!("Volume: {}", volume);

pub async fn subscribe<'_, '_>(
    &'_ self,
    url: &'_ Uri,
    timeout_secs: u32
) -> Result<(String, impl Stream<Item = Result<HashMap<String, String>, Error>>), Error>

Subscribe for state variable changes.

It returns the SID which can be used to unsubscribe to the service and a stream of responses.

Each response is a HashMap of the state variables.

Example usage:

let (_sid, stream) = service.subscribe(device.url(), 300).await?;

while let Some(state_vars) = stream.try_next().await? {
    for (key, value) in state_vars {
        println!("{} => {}", key, value);
    }
}

pub async fn renew_subscription<'_, '_, '_>(
    &'_ self,
    url: &'_ Uri,
    sid: &'_ str,
    timeout_secs: u32
) -> Result<(), Error>

Renew a subscription made with the subscribe method.

When the sid is invalid, the control point will respond with a 412 Preconditition failed.

pub async fn unsubscribe<'_, '_, '_>(
    &'_ self,
    url: &'_ Uri,
    sid: &'_ str
) -> Result<(), Error>

Unsubscribe from further event notifications.

The SID is usually obtained by the subscribe method.

When the sid is invalid, the control point will respond with a 412 Preconditition failed.

Trait Implementations

impl Clone for Service

fn clone(&self) -> Service

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Service

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

Formats the value using the given formatter.