Module jpro.webapi
Package com.jpro.webapi

Interface InstanceInfo

@Experimental public interface InstanceInfo
Holds information about the current running instance.

  • Property Summary

    Properties
    Type
    Property
    Description
    javafx.beans.property.ReadOnlyBooleanProperty
    afk
    Returns a property which indicates whether the user is considered as inactive.
    javafx.beans.property.ReadOnlyBooleanProperty
    background
    Returns a property which indicates whether the application is running in the background.
    javafx.beans.property.ReadOnlyLongProperty
    dataReceivedWS
    Returns a property with the data received via the WebSocket connection.
    javafx.beans.property.ReadOnlyLongProperty
    dataSentWS
    Returns a property with the data sent via the WebSocket connection.
    javafx.beans.property.ReadOnlyLongProperty
    lastActionTime
    Returns a property with the time of the last user action in milliseconds.
    javafx.beans.property.ReadOnlyIntegerProperty
    latency
    Returns a property with the average latency in milliseconds.
    javafx.beans.property.ReadOnlyIntegerProperty
    nodesCollected
    Returns a property with the number of nodes collected.
    javafx.beans.property.ReadOnlyIntegerProperty
    nodesCreated
    Returns a property with the number of nodes created.
    javafx.beans.property.ReadOnlyIntegerProperty
    nodesSynchronized
    Returns a property with the number of nodes synchronized.

  • Method Summary

    Modifier and Type
    Method
    Description
    javafx.beans.property.ReadOnlyBooleanProperty
    afkProperty()
    Returns a property which indicates whether the user is considered as inactive.
    javafx.beans.property.ReadOnlyBooleanProperty
    backgroundProperty()
    Returns a property which indicates whether the application is running in the background.
    long
    creationTime()
    Returns the creation time of this instance in milliseconds.
    javafx.beans.property.ReadOnlyLongProperty
    dataReceivedWSProperty()
    Returns a property with the data received via the WebSocket connection.
    javafx.beans.property.ReadOnlyLongProperty
    dataSentWSProperty()
    Returns a property with the data sent via the WebSocket connection.
    long
    getDataReceivedWS()
    Returns the length of the data received via the WebSocket connection.
    long
    getDataSentWS()
    Returns the length of the data sent via the WebSocket connection.
    String
    getInitialHostName()
    Returns the initial host name of this instance.
    long
    getLastActionTime()
    Returns a value with the time of the last user action in milliseconds.
    int
    getLatency()
    Returns the average latency in milliseconds.
    int
    getNodesCollected()
    Returns the number of nodes collected.
    int
    getNodesCreated()
    Returns the number of nodes created.
    int
    getNodesSynchronized()
    Returns the number of nodes synchronized.
    String
    getRemoteAddress()
    Returns the instance ID of this instance.
    boolean
    isAfk()
    Returns a boolean value which indicates whether the user is considered as inactive.
    boolean
    isBackground()
    Returns a boolean value which indicates whether the application is running in the background.
    javafx.beans.property.ReadOnlyLongProperty
    lastActionTimeProperty()
    Returns a property with the time of the last user action in milliseconds.
    javafx.beans.property.ReadOnlyIntegerProperty
    latencyProperty()
    Returns a property with the average latency in milliseconds.
    javafx.beans.property.ReadOnlyIntegerProperty
    nodesCollectedProperty()
    Returns a property with the number of nodes collected.
    javafx.beans.property.ReadOnlyIntegerProperty
    nodesCreatedProperty()
    Returns a property with the number of nodes created.
    javafx.beans.property.ReadOnlyIntegerProperty
    nodesSynchronizedProperty()
    Returns a property with the number of nodes synchronized.

  • Property Details

    • latency

      javafx.beans.property.ReadOnlyIntegerProperty latencyProperty
      Returns a property with the average latency in milliseconds.
      See Also:

    • dataSentWS

      javafx.beans.property.ReadOnlyLongProperty dataSentWSProperty
      Returns a property with the data sent via the WebSocket connection.
      See Also:

    • dataReceivedWS

      javafx.beans.property.ReadOnlyLongProperty dataReceivedWSProperty
      Returns a property with the data received via the WebSocket connection.
      See Also:

    • afk

      javafx.beans.property.ReadOnlyBooleanProperty afkProperty
      Returns a property which indicates whether the user is considered as inactive.
      See Also:

    • background

      javafx.beans.property.ReadOnlyBooleanProperty backgroundProperty
      Returns a property which indicates whether the application is running in the background.
      See Also:

    • lastActionTime

      javafx.beans.property.ReadOnlyLongProperty lastActionTimeProperty
      Returns a property with the time of the last user action in milliseconds.
      See Also:

    • nodesCreated

      javafx.beans.property.ReadOnlyIntegerProperty nodesCreatedProperty
      Returns a property with the number of nodes created.
      See Also:

    • nodesSynchronized

      javafx.beans.property.ReadOnlyIntegerProperty nodesSynchronizedProperty
      Returns a property with the number of nodes synchronized.
      See Also:

    • nodesCollected

      javafx.beans.property.ReadOnlyIntegerProperty nodesCollectedProperty
      Returns a property with the number of nodes collected.
      See Also:

  • Method Details

    • latencyProperty

      javafx.beans.property.ReadOnlyIntegerProperty latencyProperty()
      Returns a property with the average latency in milliseconds.
      See Also:

    • getLatency

      int getLatency()
      Returns the average latency in milliseconds.
      Returns:
      an integer value representing the current latency.

    • getInitialHostName

      String getInitialHostName()
      Returns the initial host name of this instance.
      Returns:
      a string value representing the initial host name.

    • creationTime

      long creationTime()
      Returns the creation time of this instance in milliseconds.
      Returns:
      a long value representing the creation time.

    • getRemoteAddress

      String getRemoteAddress()
      Returns the instance ID of this instance.
      Returns:
      a string value representing the instance ID.

    • dataSentWSProperty

      javafx.beans.property.ReadOnlyLongProperty dataSentWSProperty()
      Returns a property with the data sent via the WebSocket connection.
      See Also:

    • getDataSentWS

      long getDataSentWS()
      Returns the length of the data sent via the WebSocket connection.
      Returns:
      a number of data sent in bytes.

    • dataReceivedWSProperty

      javafx.beans.property.ReadOnlyLongProperty dataReceivedWSProperty()
      Returns a property with the data received via the WebSocket connection.
      See Also:

    • getDataReceivedWS

      long getDataReceivedWS()
      Returns the length of the data received via the WebSocket connection.
      Returns:
      a number of data received in bytes.

    • afkProperty

      javafx.beans.property.ReadOnlyBooleanProperty afkProperty()
      Returns a property which indicates whether the user is considered as inactive.
      See Also:

    • isAfk

      boolean isAfk()
      Returns a boolean value which indicates whether the user is considered as inactive.

    • backgroundProperty

      javafx.beans.property.ReadOnlyBooleanProperty backgroundProperty()
      Returns a property which indicates whether the application is running in the background.
      See Also:

    • isBackground

      boolean isBackground()
      Returns a boolean value which indicates whether the application is running in the background.

    • lastActionTimeProperty

      javafx.beans.property.ReadOnlyLongProperty lastActionTimeProperty()
      Returns a property with the time of the last user action in milliseconds.
      See Also:

    • getLastActionTime

      long getLastActionTime()
      Returns a value with the time of the last user action in milliseconds.

    • nodesCreatedProperty

      javafx.beans.property.ReadOnlyIntegerProperty nodesCreatedProperty()
      Returns a property with the number of nodes created.
      See Also:

    • getNodesCreated

      int getNodesCreated()
      Returns the number of nodes created.

    • nodesSynchronizedProperty

      javafx.beans.property.ReadOnlyIntegerProperty nodesSynchronizedProperty()
      Returns a property with the number of nodes synchronized.
      See Also:

    • getNodesSynchronized

      int getNodesSynchronized()
      Returns the number of nodes synchronized.

    • nodesCollectedProperty

      javafx.beans.property.ReadOnlyIntegerProperty nodesCollectedProperty()
      Returns a property with the number of nodes collected.
      See Also:

    • getNodesCollected

      int getNodesCollected()
      Returns the number of nodes collected.