-
-
Notifications
You must be signed in to change notification settings - Fork 739
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Moved CloseCode enum to own class and updated documentation
- Loading branch information
MinnDevelopment
committed
Feb 20, 2017
1 parent
5a352da
commit 0621b7c
Showing
4 changed files
with
124 additions
and
73 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
111 changes: 111 additions & 0 deletions
111
src/main/java/net/dv8tion/jda/core/requests/CloseCode.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,111 @@ | ||
| /* | ||
| * Copyright 2015-2017 Austin Keener & Michael Ritter | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package net.dv8tion.jda.core.requests; | ||
|
|
||
| /** | ||
| * Constants representing {@link net.dv8tion.jda.core.requests.WebSocketClient WebSocketClient} close codes | ||
| * with association to an explaining message. | ||
| * <br>This was inspired from the <a target="_blank" href="https://discordapp.com/developers/docs/topics/gateway#disconnections">official documentation</a> | ||
| */ | ||
| public enum CloseCode | ||
| { | ||
| GRACEFUL_CLOSE( 1000, "The connection was closed gracefully or your heartbeats timed out."), | ||
| CLOUD_FLARE_LOAD( 1001, "The connection was closed due to CloudFlare load balancing."), | ||
| INTERNAL_SERVER_ERROR(1006, "Something broke on the remote's end, sorry 'bout that... Try reconnecting!"), | ||
| UNKNOWN_ERROR( 4000, "The server is not sure what went wrong. Try reconnecting?"), | ||
| UNKNOWN_OPCODE( 4001, "You sent an invalid Gateway OP Code. Don't do that!"), | ||
| DECODE_ERROR( 4002, "You sent an invalid payload to the server. Don't do that!"), | ||
| NOT_AUTHENTICATED( 4003, "You sent a payload prior to identifying."), | ||
| AUTHENTICATION_FAILED(4004, "The account token sent with your identify payload is incorrect.", false), | ||
| ALREADY_AUTHENTICATED(4005, "You sent more than one identify payload. Don't do that!"), | ||
| INVALID_SEQ( 4007, "The sent sent when resuming the session was invalid. Reconnect and start a new session."), | ||
| RATE_LIMITED( 4008, "Woah nelly! You're sending payloads to us too quickly. Slow it down!"), | ||
| SESSION_TIMEOUT( 4009, "Your session timed out. Reconnect and start a new one."), | ||
| INVALID_SHARD( 4010, "You sent an invalid shard when identifying.", false), | ||
| SHARDING_REQUIRED( 4011, "The session would have handled too many guilds - you are required to shard your connection in order to connect.", false); | ||
|
|
||
| private final int code; | ||
| private final boolean isReconnect; | ||
| private final String meaning; | ||
|
|
||
| CloseCode(int code, String meaning) | ||
| { | ||
| this(code, meaning, true); | ||
| } | ||
|
|
||
| CloseCode(int code, String meaning, boolean isReconnect) | ||
| { | ||
| this.code = code; | ||
| this.meaning = meaning; | ||
| this.isReconnect = isReconnect; | ||
| } | ||
|
|
||
| /** | ||
| * The integer code in the form of {@code 4xxx}/{@code 1xxx} | ||
| * | ||
| * @return The integer representation for this CloseCode | ||
| */ | ||
| public int getCode() | ||
| { | ||
| return code; | ||
| } | ||
|
|
||
| /** | ||
| * The message which further explains the reason | ||
| * for this close code's occurrence | ||
| * | ||
| * @return The reason for this close | ||
| */ | ||
| public String getMeaning() | ||
| { | ||
| return meaning; | ||
| } | ||
|
|
||
| /** | ||
| * Whether the {@link net.dv8tion.jda.core.requests.WebSocketClient WebSocketClient} | ||
| * will attempt to reconnect when this close code appears | ||
| * | ||
| * @return Whether the WebSocketClient will attempt to reconnect | ||
| */ | ||
| public boolean isReconnect() | ||
| { | ||
| return isReconnect; | ||
| } | ||
|
|
||
| @Override | ||
| public String toString() | ||
| { | ||
| return "CloseCode[" + code + " / " + meaning + "]"; | ||
| } | ||
|
|
||
| /** | ||
| * Retrieves the CloseCode representation | ||
| * for the specified integer close code | ||
| * | ||
| * @param code | ||
| * The close code to match | ||
| * | ||
| * @return The CloseCode field matching the specified integer | ||
| * or {@code null} if no match was found | ||
| */ | ||
| public static CloseCode from(int code) | ||
| { | ||
| for (CloseCode c : values()) | ||
| if (c.code == code) return c; | ||
| return null; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters