Package org.openhab.core.io.transport.upnp

Interface UpnpIOParticipant

public interface UpnpIOParticipant
The UpnpIOParticipant is an interface that needs to be implemented by classes that wants to participate in UPNP communication
Author:
Karel Goderis - Initial contribution

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getUDN()
    Get the UDN of the participant
    void
    onServiceSubscribed(String service, boolean succeeded)
    Called to notify if a GENA subscription succeeded or failed.
    void
    onStatusChanged(boolean status)
    Called when the UPNP IO service is unable to poll the UDN of the participant, given that an addStatusListener is registered.
    void
    onValueReceived(String variable, String value, String service)
    Called when the UPNP IO service receives a {variable,value} tuple for the given UPNP service

  • Method Details

    • getUDN

      String getUDN()
      Get the UDN of the participant

    • onValueReceived

      void onValueReceived(String variable, String value, String service)
      Called when the UPNP IO service receives a {variable,value} tuple for the given UPNP service

    • onServiceSubscribed

      void onServiceSubscribed(String service, boolean succeeded)
      Called to notify if a GENA subscription succeeded or failed.
      Parameters:
      service - the UPnP service subscribed
      succeeded - true if the subscription succeeded; false if failed

    • onStatusChanged

      void onStatusChanged(boolean status)
      Called when the UPNP IO service is unable to poll the UDN of the participant, given that an addStatusListener is registered.
      Parameters:
      status - false, if the poll fails when the polling was previously successful; true if the poll succeeds when the polling was previously failing