Interface HomePowerPlantConnection

  • All Implemented Interfaces:
    java.io.Closeable , java.lang.AutoCloseable

    
    public interface HomePowerPlantConnection
     implements Closeable
                        

    Connection to the home power plant. Provides the ability to send and receive frames.

    Since:

    2.0

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
    • Field Summary

      Fields 
      Modifier and Type Field Description
    • Constructor Summary

      Constructors 
      Constructor Description
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
    • Method Summary

      Modifier and Type Method Description
      abstract Unit connect() Establishes the connection to the home power plant.
      abstract Unit disconnect() Closes the connection to the home power plant.
      abstract Boolean isConnected() Checks if there is a connection
      abstract Frame send(Frame frame) Sends a frame to the home power plant and returns the response
      • Methods inherited from class java.io.Closeable

        close
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

    • Method Detail

      • connect

         abstract Unit connect()

        Establishes the connection to the home power plant. If a connection already exists, this is a no-op.

        Since:

        2.0

      • disconnect

         abstract Unit disconnect()

        Closes the connection to the home power plant. If there is no connection, this is a no-op. close calls disconnect.

        Since:

        2.0

      • isConnected

         abstract Boolean isConnected()

        Checks if there is a connection

        Returns:

        true, if the connection exists, otherwise false

        Since:

        2.0

      • send

         abstract Frame send(Frame frame)

        Sends a frame to the home power plant and returns the response

        Since:

        2.0