Package net.md_5.bungee.api
Class ServerConnectRequest
- java.lang.Object
-
- net.md_5.bungee.api.ServerConnectRequest
-
public class ServerConnectRequest extends Object
A request to connect a server.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classServerConnectRequest.BuilderClass that sets default properties/adds methods to the lombok builder generated class.static classServerConnectRequest.ResultThe result from this callback after request has been executed by proxy.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ServerConnectRequest.Builderbuilder()Callback<ServerConnectRequest.Result>getCallback()Callback to execute post request.intgetConnectTimeout()Timeout in milliseconds for request.ServerConnectEvent.ReasongetReason()Reason for connecting to server.@NonNull ServerInfogetTarget()Target server to connect to.booleanisRetry()Should the player be attempted to connect to the next server in their queue if the initial request fails.booleanisSendFeedback()Should feedback from the request be sent to players, allows plugins to silently deal with the outcome on their ownvoidsetConnectTimeout(int connectTimeout)Timeout in milliseconds for request.voidsetRetry(boolean retry)Should the player be attempted to connect to the next server in their queue if the initial request fails.voidsetSendFeedback(boolean sendFeedback)Should feedback from the request be sent to players, allows plugins to silently deal with the outcome on their own
-
-
-
Method Detail
-
builder
public static ServerConnectRequest.Builder builder()
-
getTarget
@NonNull public @NonNull ServerInfo getTarget()
Target server to connect to.
-
getReason
@NonNull public ServerConnectEvent.Reason getReason()
Reason for connecting to server.
-
getCallback
public Callback<ServerConnectRequest.Result> getCallback()
Callback to execute post request.
-
getConnectTimeout
public int getConnectTimeout()
Timeout in milliseconds for request.
-
isRetry
public boolean isRetry()
Should the player be attempted to connect to the next server in their queue if the initial request fails.
-
isSendFeedback
public boolean isSendFeedback()
Should feedback from the request be sent to players, allows plugins to silently deal with the outcome on their own
-
setConnectTimeout
public void setConnectTimeout(int connectTimeout)
Timeout in milliseconds for request.
-
setRetry
public void setRetry(boolean retry)
Should the player be attempted to connect to the next server in their queue if the initial request fails.
-
setSendFeedback
public void setSendFeedback(boolean sendFeedback)
Should feedback from the request be sent to players, allows plugins to silently deal with the outcome on their own
-
-