Update parse_grpc_uri docs with keep-alive params (#99)

frequenz-floss · Nov 19, 2024 · b9cb307 · b9cb307
2 parents 4b61060 + c447006
commit b9cb307
Showing 1 changed file with 5 additions and 0 deletions.
diff --git 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.