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

api: Link to gRFCs A8/A9 for keepalive and related settings 

This is to give users a place to look to learn more.
This commit is contained in:
Eric Anderson 2023-07-31 15:40:38 -07:00
parent d9a464e725
commit 8121e8118e
2 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
api/src/main/java/io/grpc/ManagedChannelBuilder.java
View File

@ -352,6 +352,8 @@ public abstract class ManagedChannelBuilder<T extends ManagedChannelBuilder<T>>
* small of a value as necessary.
*
* @throws UnsupportedOperationException if unsupported
* @see <a href="https://github.com/grpc/proposal/blob/master/A8-client-side-keepalive.md">gRFC A8
* Client-side Keepalive</a>
* @since 1.7.0
*/
public T keepAliveTime(long keepAliveTime, TimeUnit timeUnit) {
@ -366,6 +368,8 @@ public abstract class ManagedChannelBuilder<T extends ManagedChannelBuilder<T>>
* <p>This value should be at least multiple times the RTT to allow for lost packets.
*
* @throws UnsupportedOperationException if unsupported
* @see <a href="https://github.com/grpc/proposal/blob/master/A8-client-side-keepalive.md">gRFC A8
* Client-side Keepalive</a>
* @since 1.7.0
*/
public T keepAliveTimeout(long keepAliveTimeout, TimeUnit timeUnit) {
@ -383,6 +387,8 @@ public abstract class ManagedChannelBuilder<T extends ManagedChannelBuilder<T>>
*
* @throws UnsupportedOperationException if unsupported
* @see #keepAliveTime(long, TimeUnit)
* @see <a href="https://github.com/grpc/proposal/blob/master/A8-client-side-keepalive.md">gRFC A8
* Client-side Keepalive</a>
* @since 1.7.0
*/
public T keepAliveWithoutCalls(boolean enable) {

14
api/src/main/java/io/grpc/ServerBuilder.java
View File

@ -249,6 +249,8 @@ public abstract class ServerBuilder<T extends ServerBuilder<T>> {
*
* @throws IllegalArgumentException if time is not positive
* @throws UnsupportedOperationException if unsupported
* @see <a href="https://github.com/grpc/proposal/blob/master/A9-server-side-conn-mgt.md">gRFC A9
* Server-side Connection Management</a>
* @since 1.47.0
*/
@ExperimentalApi("https://github.com/grpc/grpc-java/issues/9009")
@ -265,6 +267,8 @@ public abstract class ServerBuilder<T extends ServerBuilder<T>> {
*
* @throws IllegalArgumentException if timeout is not positive
* @throws UnsupportedOperationException if unsupported
* @see <a href="https://github.com/grpc/proposal/blob/master/A9-server-side-conn-mgt.md">gRFC A9
* Server-side Connection Management</a>
* @since 1.47.0
*/
@ExperimentalApi("https://github.com/grpc/grpc-java/issues/9009")
@ -281,6 +285,8 @@ public abstract class ServerBuilder<T extends ServerBuilder<T>> {
*
* @throws IllegalArgumentException if idle is not positive
* @throws UnsupportedOperationException if unsupported
* @see <a href="https://github.com/grpc/proposal/blob/master/A9-server-side-conn-mgt.md">gRFC A9
* Server-side Connection Management</a>
* @since 1.47.0
*/
@ExperimentalApi("https://github.com/grpc/grpc-java/issues/9009")
@ -296,6 +302,8 @@ public abstract class ServerBuilder<T extends ServerBuilder<T>> {
*
* @throws IllegalArgumentException if age is not positive
* @throws UnsupportedOperationException if unsupported
* @see <a href="https://github.com/grpc/proposal/blob/master/A9-server-side-conn-mgt.md">gRFC A9
* Server-side Connection Management</a>
* @since 1.47.0
*/
@ExperimentalApi("https://github.com/grpc/grpc-java/issues/9009")
@ -312,6 +320,8 @@ public abstract class ServerBuilder<T extends ServerBuilder<T>> {
* @throws IllegalArgumentException if grace is negative
* @throws UnsupportedOperationException if unsupported
* @see #maxConnectionAge(long, TimeUnit)
* @see <a href="https://github.com/grpc/proposal/blob/master/A9-server-side-conn-mgt.md">gRFC A9
* Server-side Connection Management</a>
* @since 1.47.0
*/
@ExperimentalApi("https://github.com/grpc/grpc-java/issues/9009")
@ -333,6 +343,8 @@ public abstract class ServerBuilder<T extends ServerBuilder<T>> {
* @throws IllegalArgumentException if time is negative
* @throws UnsupportedOperationException if unsupported
* @see #permitKeepAliveWithoutCalls(boolean)
* @see <a href="https://github.com/grpc/proposal/blob/master/A8-client-side-keepalive.md">gRFC A8
* Client-side Keepalive</a>
* @since 1.47.0
*/
@ExperimentalApi("https://github.com/grpc/grpc-java/issues/9009")
@ -346,6 +358,8 @@ public abstract class ServerBuilder<T extends ServerBuilder<T>> {
*
* @throws UnsupportedOperationException if unsupported
* @see #permitKeepAliveTime(long, TimeUnit)
* @see <a href="https://github.com/grpc/proposal/blob/master/A8-client-side-keepalive.md">gRFC A8
* Client-side Keepalive</a>
* @since 1.47.0
*/
@ExperimentalApi("https://github.com/grpc/grpc-java/issues/9009")