MCPing (MCPing 1.1.1 API)

java.lang.Object
- net.lenni0451.mcping.MCPing<R>

public class MCPing<R extends IPingResponse>
extends java.lang.Object

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MCPing<R>`	`address(java.net.InetAddress address)` Set the address of the server to ping.
`MCPing<R>`	`address(ServerAddress serverAddress)` Set the address of the server to ping.
`MCPing<R>`	`address(java.net.SocketAddress address)` Set the address of the server to ping.
`MCPing<R>`	`address(java.lang.String address)` Set the address of the server to ping.
`MCPing<R>`	`address(java.lang.String host, int port)` Set the address of the server to ping.
`MCPing<R>`	`connectedHandler(java.lang.Runnable connectedHandler)` Set a dedicated connected handler.
`MCPing<R>`	`exceptionHandler(java.util.function.Consumer<java.lang.Throwable> exceptionHandler)` Set a dedicated exception handler.
`MCPing<R>`	`finishHandler(java.util.function.Consumer<R> finishHandler)` Set a dedicated finish handler.
`java.util.concurrent.CompletableFuture<R>`	`getAsync()` Get a completable future for the ping response.
`java.util.concurrent.Future<R>`	`getAsync(java.util.concurrent.ExecutorService executor)` Get a future for the ping response.
`R`	`getSync()` Get the ping response synchronously.
`MCPing<R>`	`handler(IStatusListener statusListener)` Set the ping status listener.
`MCPing<R>`	`noResolve()` Set the address to not be resolved.
`static MCPing<BedrockPingResponse>`	`pingBedrock()` Ping a server using the bedrock protocol.
`static MCPing<ClassicPingResponse>`	`pingClassic(ClassicPing.Version version)` Ping a server using the classic protocol.
`static MCPing<MCPingResponse>`	`pingLegacy(LegacyPing.Version version)` Ping a server using the legacy ping protocol.
`static MCPing<MCPingResponse>`	`pingLegacy(LegacyPing.Version version, int protocolVersion)` Ping a server using the legacy ping protocol.
`static MCPing<MCPingResponse>`	`pingModern()` Ping a server using the modern ping protocol.
`static MCPing<MCPingResponse>`	`pingModern(int protocolVersion)` Ping a server using the modern ping protocol.
`static MCPing<QueryPingResponse>`	`pingQuery()` Ping a server using the query protocol.
`static MCPing<QueryPingResponse>`	`pingQuery(boolean full)` Ping a server using the query protocol.
`static MCPing<SocketPingResponse>`	`pingSocket()` Ping a server using a socket.
`MCPing<R>`	`resolve()` Set the address to be resolved.
`MCPing<R>`	`responseHandler(java.util.function.Consumer<R> responseHandler)` Set a dedicated response handler.
`MCPing<R>`	`timeout(int connectTimeout, int readTimeout)` Set the connect and read timeout.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - pingModern
```
public static MCPing<MCPingResponse> pingModern()
```
    Ping a server using the modern ping protocol.
    Defaults to protocol version 47.
    
    Returns:
    
    The modern ping builder
  - pingModern
```
public static MCPing<MCPingResponse> pingModern(int protocolVersion)
```
    Ping a server using the modern ping protocol.
    
    Parameters:
    
    protocolVersion - The protocol version to use
    
    Returns:
    
    The modern ping builder
  - pingLegacy
```
public static MCPing<MCPingResponse> pingLegacy(LegacyPing.Version version)
```
    Ping a server using the legacy ping protocol.
    Defaults to the protocol version of the given version (LegacyPing.Version#getDefaultId()).
    Versions between b1.8 and 1.2 are not resolving the address by default.
    
    Parameters:
    
    version - The version of the protocol
    
    Returns:
    
    The legacy ping builder
  - pingLegacy
```
public static MCPing<MCPingResponse> pingLegacy(LegacyPing.Version version,
                                                int protocolVersion)
```
    Ping a server using the legacy ping protocol.
    Versions between b1.8 and 1.2 are not resolving the address by default.
    
    Parameters:
    
    version - The version of the protocol
    
    protocolVersion - The protocol version to use
    
    Returns:
    
    The legacy ping builder
  - pingClassic
```
public static MCPing<ClassicPingResponse> pingClassic(ClassicPing.Version version)
```
    Ping a server using the classic protocol.
    Resolving the address is disabled by default.
    This visibly connects a client to the server causing a disconnect message.
    
    Parameters:
    
    version - The version of the protocol
    
    Returns:
    
    The classic ping builder
  - pingQuery
```
public static MCPing<QueryPingResponse> pingQuery()
```
    Ping a server using the query protocol.
    Defaults to full query.
    
    Returns:
    
    The query ping builder
  - pingQuery
```
public static MCPing<QueryPingResponse> pingQuery(boolean full)
```
    Ping a server using the query protocol.
    
    Parameters:
    
    full - Whether to use full query or not
    
    Returns:
    
    The query ping builder
  - pingBedrock
```
public static MCPing<BedrockPingResponse> pingBedrock()
```
    Ping a server using the bedrock protocol.
    Resolving the address is disabled by default.
    
    Returns:
    
    The bedrock ping builder
  - pingSocket
```
public static MCPing<SocketPingResponse> pingSocket()
```
    Ping a server using a socket.
    This just connects a socket and measures the time it takes to connect.
    
    Returns:
    
    The socket ping builder
  - address
```
public MCPing<R> address(java.lang.String address)
```
    Set the address of the server to ping.
    See ServerAddress.parse(String, int) for more information.
    
    Parameters:
    
    address - The string representation of the address and/or port
    
    Returns:
    
    This builder
  - address
```
public MCPing<R> address(java.lang.String host,
                         int port)
```
    Set the address of the server to ping.
    See ServerAddress.of(String, int, int) for more information.
    
    Parameters:
    
    host - The host of the server
    
    port - The port of the server
    
    Returns:
    
    This builder
  - address
```
public MCPing<R> address(ServerAddress serverAddress)
```
    Set the address of the server to ping.
    
    Parameters:
    
    serverAddress - The server address
    
    Returns:
    
    This builder
  - address
```
public MCPing<R> address(java.net.SocketAddress address)
```
    Set the address of the server to ping.
    If the address is an InetSocketAddress the host and port will be used.
    Otherwise, the address will be parsed using ServerAddress.parse(String, int).
    
    Parameters:
    
    address - The socket address
    
    Returns:
    
    This builder
  - address
```
public MCPing<R> address(java.net.InetAddress address)
```
    Set the address of the server to ping.
    The host will be resolved using InetAddress.getHostAddress().
    
    Parameters:
    
    address - The inet address
    
    Returns:
    
    This builder
  - resolve
```
public MCPing<R> resolve()
```
    Set the address to be resolved.
    
    Returns:
    
    This builder
  - noResolve
```
public MCPing<R> noResolve()
```
    Set the address to not be resolved.
    
    Returns:
    
    This builder
  - timeout
```
public MCPing<R> timeout(int connectTimeout,
                         int readTimeout)
```
    Set the connect and read timeout.
    Not all ping implementations require both timeouts.
    
    Parameters:
    
    connectTimeout - The connect timeout
    
    readTimeout - The read timeout
    
    Returns:
    
    This builder
  - handler
```
public MCPing<R> handler(IStatusListener statusListener)
```
    Set the ping status listener.
    IMPORTANT! See IStatusListener for more information about the response special cases.
    
    Parameters:
    
    statusListener - The status listener
    
    Returns:
    
    This builder
  - exceptionHandler
```
public MCPing<R> exceptionHandler(java.util.function.Consumer<java.lang.Throwable> exceptionHandler)
```
    Set a dedicated exception handler.
    See IStatusListener.onError(Throwable) for common exceptions and their cause.
    IMPORTANT! See IStatusListener for more information about the response special cases.
    
    Parameters:
    
    exceptionHandler - The exception handler
    
    Returns:
    
    This builder
  - connectedHandler
```
public MCPing<R> connectedHandler(java.lang.Runnable connectedHandler)
```
    Set a dedicated connected handler.
    This handler is called when the connection to the server was established.
    IMPORTANT! See IStatusListener for more information about the response special cases.
    
    Parameters:
    
    connectedHandler - The connected handler
    
    Returns:
    
    This builder
  - responseHandler
```
public MCPing<R> responseHandler(java.util.function.Consumer<R> responseHandler)
```
    Set a dedicated response handler.
    This handler is called when the server responds with a valid status.
    IMPORTANT! See IStatusListener for more information about the response special cases.
    
    Parameters:
    
    responseHandler - The response handler
    
    Returns:
    
    This builder
  - finishHandler
```
public MCPing<R> finishHandler(java.util.function.Consumer<R> finishHandler)
```
    Set a dedicated finish handler.
    This handler is called when the ping is finished.
    IMPORTANT! See IStatusListener for more information about the response special cases.
    
    Parameters:
    
    finishHandler - The finish handler
    
    Returns:
    
    This builder
  - getSync
```
public R getSync()
```
    Get the ping response synchronously.
    If no status listener or exception handler is set, any exception will be thrown.
    If a listener is set, null will be returned.
    
    Returns:
    
    The ping response
    
    Throws:
    
    java.lang.RuntimeException - If no status listener or exception handler is set and an exception occurs
  - getAsync
```
public java.util.concurrent.CompletableFuture<R> getAsync()
```
    Get a completable future for the ping response.
    The ping will be executed in a separate thread and started immediately.
    
    Returns:
    
    The completable future
  - getAsync
```
public java.util.concurrent.Future<R> getAsync(java.util.concurrent.ExecutorService executor)
```
    Get a future for the ping response.
    The ping will be executed in the given executor and started immediately.
    
    Parameters:
    
    executor - The executor
    
    Returns:
    
    The future

Class MCPing<R extends IPingResponse>

Method Summary

Methods inherited from class java.lang.Object

Method Detail

pingModern

pingModern

pingLegacy

pingLegacy

pingClassic

pingQuery

pingQuery

pingBedrock

pingSocket

address

address

address

address

address

resolve

noResolve

timeout

handler

exceptionHandler

connectedHandler

responseHandler

finishHandler

getSync

getAsync

getAsync