grpc
/
grpc-java
mirror of https://github.com/grpc/grpc-java.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: clarify channel state API unimplemented until v1.6.1 

Resolves #4624
This commit is contained in:
ZHANG Dapeng 2018-07-24 14:01:24 -07:00 committed by GitHub
parent 72179e22a5
commit 03d85ee53e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
core/src/main/java/io/grpc/ManagedChannel.java
View File

@ -73,6 +73,8 @@ public abstract class ManagedChannel extends Channel {
/**
* Gets the current connectivity state. Note the result may soon become outdated.
*
* <p>Note that the core library did not provide an implementation of this method until v1.6.1.
*
* @param requestConnection if {@code true}, the channel will try to make a connection if it is
* currently IDLE
* @throws UnsupportedOperationException if not supported by implementation
@ -96,6 +98,8 @@ public abstract class ManagedChannel extends Channel {
* states may not have been observed. The API is only reliable in tracking the <em>current</em>
* state.
*
* <p>Note that the core library did not provide an implementation of this method until v1.6.1.
*
* @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