From c4470064dbf7524d3d28040a77f3455d0851ef13 Mon Sep 17 00:00:00 2001 From: Sahas Subramanian Date: Tue, 19 Nov 2024 14:13:17 +0100 Subject: [PATCH] Update `parse_grpc_uri` docs with keep-alive params Signed-off-by: Sahas Subramanian --- src/frequenz/client/base/channel.py | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/src/frequenz/client/base/channel.py b/src/frequenz/client/base/channel.py index b61d522..d0d4a3c 100644 --- a/src/frequenz/client/base/channel.py +++ b/src/frequenz/client/base/channel.py @@ -101,6 +101,11 @@ def parse_grpc_uri( enabled. Will raise a `ValueError` if the file cannot be read. - `ssl_certificate_chain_path` (str): Path to the certificate chain file. Only valid if SSL is enabled. Will raise a `ValueError` if the file cannot be read. + - `keep_alive` (bool): Enable or disable HTTP2 keep-alive. Defaults to `True`. + - `keep_alive_interval_s` (float): The interval between HTTP2 pings in seconds. + Defaults to 60. + - `keep_alive_timeout_s` (float): The time to wait for a HTTP2 keep-alive response + in seconds Args: uri: The gRPC URI specifying the connection parameters.