com.universaldevices.upnp
Interface SSDPListener

All Known Implementing Classes:
UDControlPoint

public interface SSDPListener

An SSDP Event Listener interface

This interface should be implemented by all objects that are interested in being notified of SSDP events

Author:
UDArchitect

Method Summary
 void deviceRemoved(java.lang.String uuid)
          The device was removed from the network
 void newDeviceAnnounced(java.lang.String uuid, java.lang.String type, java.lang.String descriptionURL, int max_age)
          A new device was announced on the network.
 void newServiceAnnounced(java.lang.String uuid, java.lang.String type, java.lang.String descriptionURL)
          A new service was announced on the network
 void searchResult(boolean isUDI, java.lang.String uuid, java.lang.String descriptionURL)
          Search results where found
 void serviceRemoved(java.lang.String uuid, java.lang.String type)
          The service was removed from the network
 void setSearching(boolean is_searching)
          Sets whether or not we are in an asynchronous search
 

Method Detail

newDeviceAnnounced

void newDeviceAnnounced(java.lang.String uuid,
                        java.lang.String type,
                        java.lang.String descriptionURL,
                        int max_age)
A new device was announced on the network.

This event is generated on an interval by UPnP devices and can be used as
a) Heartbeat
b) capture any changes the device (such as change in the IP)

Parameters:
uuid - - the uuid of the device
type - - the type of device (UPnP types)
descriptionURL - - the URL where the description of the device may be found
max_age - - maximum age when after which we can consider device dead or inoperable

deviceRemoved

void deviceRemoved(java.lang.String uuid)
The device was removed from the network

Parameters:
uuid - - the uuid of the device removed

newServiceAnnounced

void newServiceAnnounced(java.lang.String uuid,
                         java.lang.String type,
                         java.lang.String descriptionURL)
A new service was announced on the network

Parameters:
uuid - - the uuid of the service (device/service combination)
type - - the type of the service
descriptionURL - - the URL where the description of the service may be found

serviceRemoved

void serviceRemoved(java.lang.String uuid,
                    java.lang.String type)
The service was removed from the network

Parameters:
uuid - - the uuid of the service removed
type - - the type of the service removed

searchResult

void searchResult(boolean isUDI,
                  java.lang.String uuid,
                  java.lang.String descriptionURL)
Search results where found

An asynchronous search resulted in a discovered device which is notified, through this method, to the listener

Parameters:
isUDI - - whether or not the discovered device is an ISY
uuid - - the uuid of the device
descriptionURL - - the URL where the description of the device may be found

setSearching

void setSearching(boolean is_searching)
Sets whether or not we are in an asynchronous search

If in we are already performing another asynch search another search request shall not be obliged

Parameters:
is_searching - - true if we are already searching, false otherwise