Skip to content

Commit 4d54c28

Browse files
committed
fix(jsonrpc): update stream_send_timeout doc for A2AFastAPIApplication and A2AStarletteApplication
1 parent 9228299 commit 4d54c28

File tree

3 files changed

+10
-8
lines changed

3 files changed

+10
-8
lines changed

src/a2a/server/apps/jsonrpc/fastapi_app.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -98,8 +98,10 @@ def __init__( # noqa: PLR0913
9898
call context.
9999
max_content_length: The maximum allowed content length for incoming
100100
requests. Defaults to 10MB. Set to None for unbounded maximum.
101-
stream_send_timeout: The timeout in seconds for sending events in default timeout. Set to a larger value or None to disable for
102-
long-running agents.
101+
stream_send_timeout: The timeout in seconds for sending events in
102+
streaming responses. Defaults to `None`, which disables the timeout.
103+
This changes the default behavior from using Starlette's 5-second
104+
default. Set a float value to specify a timeout.
103105
"""
104106
if not _package_fastapi_installed:
105107
raise ImportError(

src/a2a/server/apps/jsonrpc/jsonrpc_app.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -205,9 +205,9 @@ def __init__( # noqa: PLR0913
205205
max_content_length: The maximum allowed content length for incoming
206206
requests. Defaults to 10MB. Set to None for unbounded maximum.
207207
stream_send_timeout: The timeout in seconds for sending events in
208-
streaming responses. Defaults to None, which uses Starlette's
209-
default timeout. Set to a larger value or None to disable for
210-
long-running agents.
208+
streaming responses. Defaults to `None`, which disables the timeout.
209+
This changes the default behavior from using Starlette's 5-second
210+
default. Set a float value to specify a timeout.
211211
"""
212212
if not _package_starlette_installed:
213213
raise ImportError(

src/a2a/server/apps/jsonrpc/starlette_app.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -81,9 +81,9 @@ def __init__( # noqa: PLR0913
8181
max_content_length: The maximum allowed content length for incoming
8282
requests. Defaults to 10MB. Set to None for unbounded maximum.
8383
stream_send_timeout: The timeout in seconds for sending events in
84-
streaming responses. Defaults to None, which uses Starlette's
85-
default timeout. Set to a larger value or None to disable for
86-
long-running agents.
84+
streaming responses. Defaults to `None`, which disables the timeout.
85+
This changes the default behavior from using Starlette's 5-second
86+
default. Set a float value to specify a timeout.
8787
"""
8888
if not _package_starlette_installed:
8989
raise ImportError(

0 commit comments

Comments
 (0)