org.digitalmediaserver.cast

Class CastDeviceMonitor

java.lang.Object

org.digitalmediaserver.cast.CastDeviceMonitor

public final class CastDeviceMonitor
extends Object

A class that can be used to keep discover cast devices and create corresponding CastDevices while notifying registered listeners of discovered or disappearing devices.

After creating a CastDeviceMonitor, it must be started using startDiscovery(InetAddress, String).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CastDeviceMonitor.MulticastDNSServiceListener Service listener to receive mDNS service updates.

Field Summary

Fields

Modifier and Type	Field and Description
protected Set<CastDevice>	castDevices The currently "registered" cast devices
protected CastDeviceMonitor.MulticastDNSServiceListener	listener The ServiceListener that listens to mDNS changes
protected Set<DeviceDiscoveryListener>	listeners The Set of DeviceDiscoveryListener to notify of changes
protected Object	lock The synchronization object
protected javax.jmdns.JmDNS	mDNS The mDNS instance

Constructor Summary

Constructors

Constructor and Description
CastDeviceMonitor() Creates a new instance.

Method Summary

Modifier and Type	Method and Description
protected void	finalize()
Set<CastDevice>	getCastDevices()
boolean	registerListener(DeviceDiscoveryListener listener) Register a new DeviceDiscoveryListener that will be notified when cast devices are found or disappears.
void	startDiscovery() Starts discovery of cast devices.
void	startDiscovery(InetAddress addr, String name) Starts discovery of cast devices.
void	stopDiscovery() Stops discovery of cast devices and removes all discovered devices.
void	stopDiscovery(boolean notifyListeners) Stops discovery of cast devices and removes all discovered devices.
boolean	unregisterListener(DeviceDiscoveryListener listener) Unregister a DeviceDiscoveryListener so that it will no longer be notified when cast devices are found or disappears.

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

listener

@Nonnull
protected final CastDeviceMonitor.MulticastDNSServiceListener listener

The ServiceListener that listens to mDNS changes

lock

@Nonnull
protected final Object lock

The synchronization object

mDNS

@Nullable
protected javax.jmdns.JmDNS mDNS

The mDNS instance

listeners

@Nonnull
protected final Set<DeviceDiscoveryListener> listeners

The Set of DeviceDiscoveryListener to notify of changes

castDevices

@Nonnull
protected final Set<CastDevice> castDevices

The currently "registered" cast devices

Constructor Detail

CastDeviceMonitor

public CastDeviceMonitor()

Creates a new instance. Use startDiscovery() to start monitoring.

Method Detail

getCastDevices

public Set<CastDevice> getCastDevices()

Returns:

A Set with a snapshot of the currently known cast devices.

startDiscovery

public void startDiscovery()
                    throws IOException

Starts discovery of cast devices.

Note: This is a convenience method. The preferred constructor is startDiscovery(InetAddress, String). Check that your platform correctly handles the default localhost IP address and the local hostname. If in doubt, use the explicit constructor.

This method is equivalent to startDiscovery(null, null).

Throws:

IOException - If an error occurs during the operation.

startDiscovery

public void startDiscovery(@Nullable
                           InetAddress addr,
                           @Nullable
                           String name)
                    throws IOException

Starts discovery of cast devices.

Parameters:

addr - the IP address to bind to.

name - the name of the multicast DNS "device" that will be created to participate in the "multicast DNS network".

Throws:

IOException - If an error occurs during the operation.

stopDiscovery

public void stopDiscovery()
                   throws IOException

Stops discovery of cast devices and removes all discovered devices.

Throws:

IOException - If an error occurs during the operation.

stopDiscovery

public void stopDiscovery(boolean notifyListeners)
                   throws IOException

Stops discovery of cast devices and removes all discovered devices.

Parameters:

notifyListeners - if true, also notifies listeners that the devices are removed, to trigger potential cleanup.

Throws:

IOException - If an error occurs during the operation.

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

registerListener

public boolean registerListener(@Nullable
                                DeviceDiscoveryListener listener)

Register a new DeviceDiscoveryListener that will be notified when cast devices are found or disappears. It will also be notified of any already known cast devices at the time of registration before returning.

Parameters:

listener - the DeviceDiscoveryListener to add.

Returns:

true if the new listener was registered, false if it was registered already.

unregisterListener

public boolean unregisterListener(@Nullable
                                  DeviceDiscoveryListener listener)

Unregister a DeviceDiscoveryListener so that it will no longer be notified when cast devices are found or disappears.

Parameters:

listener - the DeviceDiscoveryListener to remove.

Returns:

true if the listener was unregistered, false if it wasn't registered before the call.