Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add ability to manually shut down channels #384

Merged
merged 5 commits into from
Feb 28, 2019

Conversation

rebello95
Copy link
Collaborator

Addresses #198.

It's currently not possible to manually shut down a gRPC channel, which means that the only way to shut down a channel is to deallocate it. This requirement is a bit fragile for cases where a consumer wants to manually shut down a channel, since it requires confidence that nothing else is holding a strong reference to the channel.

This PR:

  • Adds a shutdown function to Channel, allowing consumers to arbitrarily shut down connections
  • Cancels all existing calls that are using the channel upon shutdown
  • Validates that existing calls will throw errors when attempting to read/write from a previously shut down channel
  • Ensures creating new calls using previously shut down channels will result in the initializer throwing (already handled by code generators)

This change is increasingly relevant because consumers will need to shut down channels and restart them to help mitigate issues when switching between wifi/cellular as mentioned here: #337.

Addresses grpc#198.

It's currently not possible to manually shut down a gRPC channel, which means that the only way to shut down a channel is to deallocate it. This requirement is a bit fragile for cases where a consumer wants to manually shut down a channel, since it requires confidence that nothing else is holding a strong reference to the channel.

This PR:
- Adds a `shutdown` function to `Channel`, allowing consumers to arbitrarily shut down connections
- Cancels all existing calls that are using the channel upon shutdown
- Validates that existing calls will throw errors when attempting to read/write from a previously shut down channel
- Ensures creating new calls using previously shut down channels will result in the initializer throwing (already handled by code generators)

This change is increasingly relevant because consumers will need to shut down channels and restart them to help mitigate issues when switching between wifi/cellular as mentioned here: grpc#337.
@rebello95 rebello95 requested review from timburks and MrMage February 26, 2019 18:49
Copy link
Collaborator

@MrMage MrMage left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Haven't looked at the test yet, just a few general thoughts.

Sources/Examples/Simple/main.swift Outdated Show resolved Hide resolved
Sources/SwiftGRPC/Core/Channel.swift Outdated Show resolved Hide resolved
Sources/SwiftGRPC/Core/Channel.swift Outdated Show resolved Hide resolved
Sources/SwiftGRPC/Core/Channel.swift Show resolved Hide resolved
Copy link
Collaborator

@MrMage MrMage left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking good, just a few more thoughts.

Sources/SwiftGRPC/Core/Channel.swift Outdated Show resolved Hide resolved
Sources/SwiftGRPC/Core/Channel.swift Outdated Show resolved Hide resolved
Tests/SwiftGRPCTests/ChannelShutdownTests.swift Outdated Show resolved Hide resolved
Tests/SwiftGRPCTests/ChannelShutdownTests.swift Outdated Show resolved Hide resolved
@MrMage MrMage merged commit 930440a into grpc:master Feb 28, 2019
@rebello95 rebello95 deleted the channel-shutdown branch February 28, 2019 15:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants