From 4a22a1ef16b0e9596ebed1b2697845baf4de1373 Mon Sep 17 00:00:00 2001 From: Pedro Calado Date: Fri, 30 Oct 2020 18:13:29 +0000 Subject: [PATCH] feat(transport): expose HTTP2 server keepalive interval and timeout Adds two methods to `transport::server::Server` for setting HTTP2 server keepalive interval and timeout as exposed by `hyper::server::Builder`. Fixes #474 --- tonic/src/transport/server/mod.rs | 42 ++++++++++++++++++++++++++++++- 1 file changed, 41 insertions(+), 1 deletion(-) diff --git a/tonic/src/transport/server/mod.rs b/tonic/src/transport/server/mod.rs index 490654f90..577516570 100644 --- a/tonic/src/transport/server/mod.rs +++ b/tonic/src/transport/server/mod.rs @@ -51,6 +51,8 @@ use tracing_futures::{Instrument, Instrumented}; type BoxService = tower::util::BoxService, Response, crate::Error>; type TraceInterceptor = Arc tracing::Span + Send + Sync + 'static>; +const DEFAULT_HTTP2_KEEPALIVE_TIMEOUT_SECS: u64 = 20; + /// A default batteries included `transport` server. /// /// This is a wrapper around [`hyper::Server`] and provides an easy builder @@ -71,6 +73,8 @@ pub struct Server { max_concurrent_streams: Option, tcp_keepalive: Option, tcp_nodelay: bool, + http2_keepalive_interval: Option, + http2_keepalive_timeout: Option, } /// A stack based `Service` router. @@ -221,6 +225,36 @@ impl Server { } } + /// Set whether HTTP2 Ping frames are enabled on accepted connections. + /// + /// If `None` is specified, HTTP2 keepalive is disabled, otherwise the duration + /// specified will be the time interval between HTTP2 Ping frames. + /// The timeout for receiving an acknowledgement of the keepalive ping + /// can be set with [`Server::http2_keepalive_timeout`]. + /// + /// Default is no HTTP2 keepalive (`None`) + /// + pub fn http2_keepalive_interval(self, http2_keepalive_interval: Option) -> Self { + Server { + http2_keepalive_interval, + ..self + } + } + + /// Sets a timeout for receiving an acknowledgement of the keepalive ping. + /// + /// If the ping is not acknowledged within the timeout, the connection will be closed. + /// Does nothing if http2_keep_alive_interval is disabled. + /// + /// Default is 20 seconds. + /// + pub fn http2_keepalive_timeout(self, http2_keepalive_timeout: Option) -> Self { + Server { + http2_keepalive_timeout, + ..self + } + } + /// Set whether TCP keepalive messages are enabled on accepted connections. /// /// If `None` is specified, keepalive is disabled, otherwise the duration @@ -321,6 +355,10 @@ impl Server { let init_stream_window_size = self.init_stream_window_size; let max_concurrent_streams = self.max_concurrent_streams; let timeout = self.timeout; + let http2_keepalive_interval = self.http2_keepalive_interval; + let http2_keepalive_timeout = self + .http2_keepalive_timeout + .unwrap_or(Duration::new(DEFAULT_HTTP2_KEEPALIVE_TIMEOUT_SECS, 0)); let tcp = incoming::tcp_incoming(incoming, self); let incoming = accept::from_stream::<_, _, crate::Error>(tcp); @@ -336,7 +374,9 @@ impl Server { .http2_only(true) .http2_initial_connection_window_size(init_connection_window_size) .http2_initial_stream_window_size(init_stream_window_size) - .http2_max_concurrent_streams(max_concurrent_streams); + .http2_max_concurrent_streams(max_concurrent_streams) + .http2_keep_alive_interval(http2_keepalive_interval) + .http2_keep_alive_timeout(http2_keepalive_timeout); if let Some(signal) = signal { server