Allow clients to shutdown gracefully #1308
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation:
If users wish to shutdown their client after all running RPCs have
completed then it is currently up to them to monitor when all of their
running RPCs have completed. This is somewhat awkward and we should
provide a better way to do this.
Modifications:
GRPCChannelprotocol which have defaultimplementations to avoid breaking API:
closeGracefully(deadline:promise:), andclose(promise:)(the future-based version already exists)ConnectionManagerhas been updated to shutdown with a'mode', either forceful or graceful and accept a promise.
changed slightly to complete when the
closeFutureis resolved.This required ignoring SSL unclean shutdown errors (which can safely
be ignored for gRPC).
frames when the client closes and there are no open streams. If there
are open streams the layers above (i.e.
ConnectionManagerandChannelPool) will not request new streams.Results:
A
GRPCChannelmay be shutdown gracefully, allowing existing RPCs torun to completion.