Add additional timeout parameters to StarletteAdapter.

Author: EvieePy

docs/getting-started/changelog.rst

@@ -115,13 +115,14 @@ Changelog
 
 - twitchio.web.StarletteAdapter
     - Additions
-        - Added the ``timeout_keep_alive`` keyword parameter which allows controlling how long ``Starlette/Uvicorn`` will wait to gracefully close.
+        - Added the ``timeout_graceful_shutdown`` keyword parameter which allows controlling how long ``Starlette/Uvicorn`` will wait to gracefully close.
+        - Added the ``timeout_keep_alive`` keyword parameter which allows controlling how long ``Uvicorn`` will wait until closing Keep-Alive connections after not receiving any data.
 
     - Bug fixes
         - Fixed the redirect URL not allowing HOST/PORT when a custom domain was passed.
             - The redirect URL is now determined based on where the request came from.
         - Fixed Uvicorn hanging the process when attempting to close the :class:`asyncio.Loop` on **Windows**.
-            - After a default of ``5 seconds`` Uvicorn will be forced closed if it cannot gracefully close in this time. This time can be changed with the ``timeout_keep_alive`` parameter.
+            - After a default of ``3 seconds`` Uvicorn will be forced closed if it cannot gracefully close in this time. This time can be changed with the ``timeout_graceful_shutdown`` parameter.
         - Now correctly changes the protocol to ``https`` when SSL is used directly on the adapter.
 
 - ext.commands

twitchio/web/starlette_adapter.py

@@ -113,6 +113,12 @@ class StarletteAdapter(BaseAdapter, Starlette):
         An optional password to decrypt the ssl key, passed to Uvicorn.
     ssl_certfile: str | PathLike[str] | None
         An optional SSL certificate file, passed to Uvicorn.
+    timeout_keep_alive: int
+        An optional :class:`int` which is the maximum amount of time in seconds ``Uvicorn`` should wait before closing
+        Keep-Alive connections. Defaults to ``5``.
+    timeout_graceful_shutdown: int
+        An optional :class:`int` which is the maximum amount of time in seconds ``Uvicorn`` should wait before forcefully
+        closing. Defaults to ``3``.
 
     Examples
     --------
@@ -154,7 +160,11 @@ def __init__(
         ssl_keyfile: str | PathLike[str] | None = None,
         ssl_keyfile_password: str | None = None,
         ssl_certfile: str | PathLike[str] | None = None,
+        timeout_keep_alive: int = 5,
+        timeout_graceful_shutdown: int = 3,
     ) -> None:
+        self._timeout_keep_alive = timeout_keep_alive
+        self._timeout_graceful_shutdown = timeout_graceful_shutdown
         self._host: str = host or "localhost"
         self._port: int = port or 4343
 
@@ -266,11 +276,11 @@ async def run(self, host: str | None = None, port: int | None = None) -> None:
             port=self._port,
             log_level="critical",
             workers=0,
-            timeout_graceful_shutdown=3,
+            timeout_graceful_shutdown=self._timeout_graceful_shutdown,
             ssl_keyfile=self.__keyfile,
             ssl_keyfile_password=self.__keypass,
             ssl_certfile=self.__certfile,
-            timeout_keep_alive=5,
+            timeout_keep_alive=self._timeout_keep_alive,
         )
 
         self._server = uvicorn.Server(config)