Skip to content

core: Mention limitations of connectivity state API #3965

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jan 12, 2018
Merged

core: Mention limitations of connectivity state API #3965

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions core/src/main/java/io/grpc/ManagedChannel.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,13 @@ public ConnectivityState getState(boolean requestConnection) {
* #getState}. If the states are already different, the callback will be called immediately. The
* callback is run in the same executor that runs Call listeners.
*
* <p>There is an inherent race between the notification to {@code callback} and any call to
* {@code getState()}. There is a similar race between {@code getState()} and a call to {@code
* notifyWhenStateChanged()}. The state can change during those races, so there is not a way to
* see every state transition. "Transitions" to the same state are possible, because intermediate
* states may not have been observed. The API is only reliable in tracking the <em>current</em>
* state.
*
* @param source the assumed current state, typically just returned by {@link #getState}
* @param callback the one-off callback
* @throws UnsupportedOperationException if not supported by implementation
Expand Down