YAACC - UPNP Client and Server
Loading...
Searching...
No Matches
de.yaacc.yxc.YxcDescriptionInfo Class Reference

What the UPnP device description of a device says about its YXC service (see YxcDescriptionParser): where the control URL is, which version, on which host and port, and the identity (UDN, serial number) that ties the description to the answer of system/getDeviceInfo. More...

Collaboration diagram for de.yaacc.yxc.YxcDescriptionInfo:
Collaboration graph

Public Member Functions

String getControlUrl ()
 
String getVersion ()
 
String getHost ()
 
int getPort ()
 
String getUdn ()
 
String getSerialNumber ()
 
String getFriendlyName ()
 
String getControlBaseUrl ()
 
String getUdnSuffix ()
 
boolean matchesDeviceId (String deviceId)
 True when the UDN suffix equals the device_id of getDeviceInfo, ignoring case.
 
boolean matchesSystemId (String systemId)
 True when the serial number of the description equals the system_id of getDeviceInfo, ignoring case.
 
String toString ()
 

Detailed Description

What the UPnP device description of a device says about its YXC service (see YxcDescriptionParser): where the control URL is, which version, on which host and port, and the identity (UDN, serial number) that ties the description to the answer of system/getDeviceInfo.

Immutable. Verified on the owner's devices (2026-11-02): the last 12 hex digits of the UDN are the device_id and the serial number of the description is the system_id.

The identity values are not part of toString() so that a log line does not carry them.

Member Function Documentation

◆ getControlBaseUrl()

String de.yaacc.yxc.YxcDescriptionInfo.getControlBaseUrl ( )
Returns
http://<host>[:port]<control url> from the URL base of the description, null when the description gave no usable URL base. A caller that fetched the description from an address should prefer that address over the one a document names.

◆ getControlUrl()

String de.yaacc.yxc.YxcDescriptionInfo.getControlUrl ( )
Returns
the path of the YXC control URL, for example /YamahaExtendedControl/v1/; never null

◆ getHost()

String de.yaacc.yxc.YxcDescriptionInfo.getHost ( )
Returns
the host of X_URLBase (an IPv6 literal without brackets), null if absent or not usable

◆ getPort()

int de.yaacc.yxc.YxcDescriptionInfo.getPort ( )
Returns
the port of X_URLBase, 80 when it has none

◆ getSerialNumber()

String de.yaacc.yxc.YxcDescriptionInfo.getSerialNumber ( )
Returns
the serialNumber of the description, null if absent

◆ getUdn()

String de.yaacc.yxc.YxcDescriptionInfo.getUdn ( )
Returns
the UDN as written (uuid:...), null if absent

◆ getUdnSuffix()

String de.yaacc.yxc.YxcDescriptionInfo.getUdnSuffix ( )
Returns
the last 12 characters of the UDN when they are hex digits, in lower case; null otherwise

Referenced by de.yaacc.yxc.YxcDescriptionInfo.matchesDeviceId().

Here is the caller graph for this function:

◆ getVersion()

String de.yaacc.yxc.YxcDescriptionInfo.getVersion ( )
Returns
the X_yxcVersion text, null if absent

The documentation for this class was generated from the following file: