Package com.btcvelocity.api.bridge

Record Class BridgeMessage.Health

java.lang.Object
java.lang.Record
com.btcvelocity.api.bridge.BridgeMessage.Health
Record Components:
serverName - the name of the reporting server
mspt - the milliseconds per tick the server is currently averaging
tps - the ticks per second the server is currently averaging
playerCount - the number of players connected to the backend
loadedWorlds - the list of worlds currently loaded on the backend
All Implemented Interfaces:
BridgeMessage
Enclosing interface:
BridgeMessage
public static record BridgeMessage.Health(String serverName, double mspt, double tps, int playerCount, List<String> loadedWorlds) extends Record implements BridgeMessage
Backend -> Proxy: a periodic health report from a backend server.

  • Constructor Details

    • Health

      public Health(String serverName, double mspt, double tps, int playerCount, List<String> loadedWorlds)
      Creates an instance of a Health record class.
      Parameters:
      serverName - the value for the serverName record component
      mspt - the value for the mspt record component
      tps - the value for the tps record component
      playerCount - the value for the playerCount record component
      loadedWorlds - the value for the loadedWorlds record component

  • Method Details

    • type

      public String type()
      Description copied from interface: BridgeMessage
      Returns the string discriminator used to route this message during (de)serialization.
      Specified by:
      type in interface BridgeMessage
      Returns:
      the message type identifier

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • serverName

      public String serverName()
      Returns the value of the serverName record component.
      Returns:
      the value of the serverName record component

    • mspt

      public double mspt()
      Returns the value of the mspt record component.
      Returns:
      the value of the mspt record component

    • tps

      public double tps()
      Returns the value of the tps record component.
      Returns:
      the value of the tps record component

    • playerCount

      public int playerCount()
      Returns the value of the playerCount record component.
      Returns:
      the value of the playerCount record component

    • loadedWorlds

      public List<String> loadedWorlds()
      Returns the value of the loadedWorlds record component.
      Returns:
      the value of the loadedWorlds record component