Interface IHostConnection

  • All Known Subinterfaces:
    IZOSHostConnection, IZOSUserProgramConnection

    public interface IHostConnection
    Generic interface for a connection to a defined IHost.
    Since:
    1.0.0
    Version:
    2.0.0
    See Also:
    IHost
    Restriction:
    This interface is not intended to be extended by clients.
    Restriction:
    This interface is not intended to be implemented by clients.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void disconnect()
      Disconnects from the associated host.
      IHost getHost()
      Returns the host associated with this host connection.
      boolean isConnected()
      Returns whether this host connection is currently connected to the associated host.
    • Method Detail

      • disconnect

        void disconnect()
        Disconnects from the associated host.

        Though not necessary, clients are strongly encouraged to disconnect from a host once they no longer need it.

        Since:
        1.0.0
      • getHost

        IHost getHost()
        Returns the host associated with this host connection.
        Returns:
        the host
        Since:
        1.0.0
      • isConnected

        boolean isConnected()
        Returns whether this host connection is currently connected to the associated host.
        Returns:
        true if connected, false otherwise
        Since:
        1.0.0