forked from grpc/grpc-java
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathThrottler.java
More file actions
45 lines (40 loc) · 1.61 KB
/
Throttler.java
File metadata and controls
45 lines (40 loc) · 1.61 KB
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
/*
* Copyright 2020 The gRPC Authors
*
* 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 io.grpc.rls;
import javax.annotation.concurrent.ThreadSafe;
/**
* A strategy for deciding when to throttle requests at the client.
*/
@ThreadSafe
interface Throttler {
/**
* Checks if a given request should be throttled by the client. This should be called for every
* request before allowing it to hit the network. If the returned value is true, the request
* should be aborted immediately (as if it had been throttled by the server).
*
* <p>This updates internal state and should be called exactly once for each request.
*/
boolean shouldThrottle();
/**
* Registers a response received from the backend for a request allowed by shouldThrottle. This
* should be called for every response received from the backend (i.e., once for each request for
* which ShouldThrottle returned false). This updates the internal statistics used by
* shouldThrottle.
*
* @param throttled specifies whether the request was throttled by the backend.
*/
void registerBackendResponse(boolean throttled);
}