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

One UDP datagram pushed by a device, reduced to the blocks and update flags yaacc reacts to. More...

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

Classes

class  NetUsbBlock
 The network source block.
 
class  ZoneBlock
 The block of a zone (main, zone2, ...).
 

Public Member Functions

String getDeviceId ()
 
boolean isParsable ()
 
Map< String, ZoneBlock > getZones ()
 
NetUsbBlock getNetUsb ()
 
Set< String > getBlockNames ()
 
boolean hasBlock (String name)
 
boolean isTunerPlayInfoUpdated ()
 
boolean isDistInfoUpdated ()
 The group state changed: read dist/getDistributionInfo.
 
boolean isClockSettingsUpdated ()
 
boolean isSystemFuncStatusUpdated ()
 The device-level settings changed: read system/getFuncStatus.
 

Static Public Member Functions

static YxcEvent unparsable ()
 The result for a datagram that is no JSON object (or too large / nested to be one of ours).
 

Detailed Description

One UDP datagram pushed by a device, reduced to the blocks and update flags yaacc reacts to.

Keys it does not know are not kept. A datagram that cannot be read is unparsable(): the receiver should then read the whole state again.

Member Function Documentation

◆ getBlockNames()

Set< String > de.yaacc.yxc.YxcEvent.getBlockNames ( )
Returns
the names of the known blocks that are present: zone ids, netusb, tuner, dist, clock, system

◆ getDeviceId()

String de.yaacc.yxc.YxcEvent.getDeviceId ( )
Returns
the device_id the device puts at the top level of every event (the same value as device_id of getDeviceInfo and the last 12 hex digits of the UPnP UDN), null if the datagram has none. Compare it case-insensitively; it is a device identifier: keep it out of log lines.

◆ getNetUsb()

NetUsbBlock de.yaacc.yxc.YxcEvent.getNetUsb ( )
Returns
the network source block, null if the datagram has none

◆ getZones()

Map< String, ZoneBlock > de.yaacc.yxc.YxcEvent.getZones ( )
Returns
the zone blocks by zone id in datagram order

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