-
Notifications
You must be signed in to change notification settings - Fork 3.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
netty: GOAWAY should trigger transportShutdown
Long-lived streams or lengthy RPCs can keep the transport open for minutes after a GOAWAY is received. Previously, during this time any new RPCs would fail with a message like: > Cannot create stream 5 since this endpoint has received a GOAWAY frame > with last stream id 3 All usages of goAwayStatus were replaced with lifecycleManager. Although note that previously goAwayStatus() would never return null because it would generate a Status if the current field was null. getShutdownStatus() does not have this feature, so some code was rearranged to guarantee the Status is non-null before retrieving it. The listener handling was simplified by 1) avoiding the need for thread-safety and 2) moving state keeping into a small class for easy comprehensibility and simplified usage in tests. NettyClientTransport.shutdown() no longer calls transportShutdown() because it lies (because the message can be delayed for quite some time) and because it was the only usage of lifecycleManager not on the event loop. Fixes #1359
- Loading branch information
Showing
6 changed files
with
173 additions
and
129 deletions.
There are no files selected for viewing
86 changes: 86 additions & 0 deletions
86
netty/src/main/java/io/grpc/netty/ClientTransportLifecycleManager.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,86 @@ | ||
/* | ||
* Copyright 2016, Google Inc. All rights reserved. | ||
* | ||
* Redistribution and use in source and binary forms, with or without | ||
* modification, are permitted provided that the following conditions are | ||
* met: | ||
* | ||
* * Redistributions of source code must retain the above copyright | ||
* notice, this list of conditions and the following disclaimer. | ||
* * Redistributions in binary form must reproduce the above | ||
* copyright notice, this list of conditions and the following disclaimer | ||
* in the documentation and/or other materials provided with the | ||
* distribution. | ||
* | ||
* * Neither the name of Google Inc. nor the names of its | ||
* contributors may be used to endorse or promote products derived from | ||
* this software without specific prior written permission. | ||
* | ||
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | ||
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | ||
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | ||
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | ||
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | ||
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT | ||
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, | ||
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY | ||
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | ||
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | ||
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | ||
*/ | ||
|
||
package io.grpc.netty; | ||
|
||
import io.grpc.Status; | ||
import io.grpc.internal.ManagedClientTransport; | ||
|
||
/** Maintainer of transport lifecycle status. */ | ||
final class ClientTransportLifecycleManager { | ||
private final ManagedClientTransport.Listener listener; | ||
private boolean transportReady; | ||
private boolean transportShutdown; | ||
/** null iff !transportShutdown. */ | ||
private Status shutdownStatus; | ||
/** null iff !transportShutdown. */ | ||
private Throwable shutdownThrowable; | ||
private boolean transportTerminated; | ||
|
||
public ClientTransportLifecycleManager(ManagedClientTransport.Listener listener) { | ||
this.listener = listener; | ||
} | ||
|
||
public void notifyReady() { | ||
if (transportReady || transportShutdown) { | ||
return; | ||
} | ||
transportReady = true; | ||
listener.transportReady(); | ||
} | ||
|
||
public void notifyShutdown(Status s) { | ||
if (transportShutdown) { | ||
return; | ||
} | ||
transportShutdown = true; | ||
shutdownStatus = s; | ||
shutdownThrowable = s.asException(); | ||
listener.transportShutdown(s); | ||
} | ||
|
||
public void notifyTerminated(Status s) { | ||
if (transportTerminated) { | ||
return; | ||
} | ||
transportTerminated = true; | ||
notifyShutdown(s); | ||
listener.transportTerminated(); | ||
} | ||
|
||
public Status getShutdownStatus() { | ||
return shutdownStatus; | ||
} | ||
|
||
public Throwable getShutdownThrowable() { | ||
return shutdownThrowable; | ||
} | ||
} |
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
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
Oops, something went wrong.