Class PingOptions
java.lang.Object
com.velocitypowered.api.proxy.server.PingOptions
Contains the parameters used to ping a
RegisteredServer
.
This class is immutable.- Since:
- 3.2.0
- See Also:
-
Nested Class Summary
-
Field Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic PingOptions.Builder
builder()
Create a new builder to assign values to a new PingOptions.boolean
The protocol version used to ping the server.long
The maximum period of time to wait for a response from the remote server.int
hashCode()
toString()
-
Field Details
-
DEFAULT
Default PingOptions.
-
-
Method Details
-
getProtocolVersion
The protocol version used to ping the server.- Returns:
- the emulated Minecraft version
-
getTimeout
public long getTimeout()The maximum period of time to wait for a response from the remote server.- Returns:
- the server ping timeout in milliseconds
-
builder
Create a new builder to assign values to a new PingOptions.- Returns:
- a new
PingOptions.Builder
-
equals
-
hashCode
public int hashCode() -
toString
-