-
Notifications
You must be signed in to change notification settings - Fork 3.8k
/
ServerCallTimeoutInterceptor.java
134 lines (120 loc) · 4.34 KB
/
ServerCallTimeoutInterceptor.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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
/*
* Copyright 2023 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.util;
import io.grpc.Context;
import io.grpc.ExperimentalApi;
import io.grpc.ForwardingServerCallListener;
import io.grpc.Metadata;
import io.grpc.ServerCall;
import io.grpc.ServerCallHandler;
import io.grpc.ServerInterceptor;
/**
* An optional ServerInterceptor to stop server calls at best effort when the timeout is reached.
* In this way, it prevents problematic code from excessively using up all threads in the pool.
*
* <p>How to use: install it to your server using ServerBuilder#intercept(ServerInterceptor).
*
* <p>Limitation: it only applies the timeout to unary calls
* (long-running streaming calls are allowed, so they can run without this timeout limit).
*/
@ExperimentalApi("https://github.com/grpc/grpc-java/issues/10361")
public class ServerCallTimeoutInterceptor implements ServerInterceptor {
private final ServerTimeoutManager serverTimeoutManager;
public ServerCallTimeoutInterceptor(ServerTimeoutManager serverTimeoutManager) {
this.serverTimeoutManager = serverTimeoutManager;
}
@Override
public <ReqT, RespT> ServerCall.Listener<ReqT> interceptCall(
ServerCall<ReqT, RespT> serverCall,
Metadata metadata,
ServerCallHandler<ReqT, RespT> serverCallHandler) {
// Only intercepts unary calls because the timeout is inapplicable to streaming calls.
if (serverCall.getMethodDescriptor().getType().clientSendsOneMessage()) {
ServerCall<ReqT, RespT> serializingServerCall = new SerializingServerCall<>(serverCall);
Context.CancellableContext timeoutContext =
serverTimeoutManager.startTimeoutContext(serializingServerCall);
if (timeoutContext != null) {
return new TimeoutServerCallListener<>(
serverCallHandler.startCall(serializingServerCall, metadata),
timeoutContext,
serverTimeoutManager);
}
}
return serverCallHandler.startCall(serverCall, metadata);
}
/** A listener that intercepts RPC callbacks for timeout control. */
static class TimeoutServerCallListener<ReqT>
extends ForwardingServerCallListener.SimpleForwardingServerCallListener<ReqT> {
private final Context.CancellableContext context;
private final ServerTimeoutManager serverTimeoutManager;
private TimeoutServerCallListener(
ServerCall.Listener<ReqT> delegate,
Context.CancellableContext context,
ServerTimeoutManager serverTimeoutManager) {
super(delegate);
this.context = context;
this.serverTimeoutManager = serverTimeoutManager;
}
@Override
public void onMessage(ReqT message) {
Context previous = context.attach();
try {
super.onMessage(message);
} finally {
context.detach(previous);
}
}
/**
* Adds interruption here because the application RPC method is called in halfClose(). See
* io.grpc.stub.ServerCalls.UnaryServerCallHandler.UnaryServerCallListener
*/
@Override
public void onHalfClose() {
serverTimeoutManager.withInterruption(context, super::onHalfClose);
}
@Override
public void onCancel() {
Context previous = context.attach();
try {
super.onCancel();
} finally {
context.detach(previous);
// Cancel the timeout when the call is finished.
context.close();
}
}
@Override
public void onComplete() {
Context previous = context.attach();
try {
super.onComplete();
} finally {
context.detach(previous);
// Cancel the timeout when the call is finished.
context.close();
}
}
@Override
public void onReady() {
Context previous = context.attach();
try {
super.onReady();
} finally {
context.detach(previous);
}
}
}
}