/
RateLimiter.java
84 lines (69 loc) · 2.36 KB
/
RateLimiter.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
/*
* Copyright 2015 Austin Keener, Michael Ritter, Florian Spieß, and the JDA contributors
*
* 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.internal.requests;
import net.dv8tion.jda.api.requests.Request;
import net.dv8tion.jda.internal.utils.JDALogger;
import org.slf4j.Logger;
import java.util.Iterator;
@SuppressWarnings("rawtypes")
public abstract class RateLimiter
{
//Implementations of this class exist in the net.dv8tion.jda.api.requests.ratelimit package.
protected static final Logger log = JDALogger.getLog(RateLimiter.class);
protected final Requester requester;
protected volatile boolean isShutdown = false, isStopped = false;
protected RateLimiter(Requester requester)
{
this.requester = requester;
}
protected boolean isSkipped(Iterator<Request> it, Request request)
{
if (request.isSkipped())
{
cancel(it, request);
return true;
}
return false;
}
private void cancel(Iterator<Request> it, Request request)
{
request.onCancelled();
it.remove();
}
// -- Required Implementations --
public abstract Long getRateLimit(Route.CompiledRoute route);
protected abstract void queueRequest(Request request);
protected abstract Long handleResponse(Route.CompiledRoute route, okhttp3.Response response);
// --- Default Implementations --
public boolean isRateLimited(Route.CompiledRoute route)
{
Long rateLimit = getRateLimit(route);
return rateLimit != null && rateLimit > 0L;
}
public abstract int cancelRequests();
public void init() {}
// Return true if no more requests will be processed
protected boolean stop()
{
isStopped = true;
return true;
}
protected void shutdown()
{
isShutdown = true;
stop();
}
}