Skip to content

Commit

Permalink
Clearer documentation for the max_http_buffer_size argument
Browse files Browse the repository at this point in the history
  • Loading branch information
miguelgrinberg committed Jan 6, 2024
1 parent cea2f92 commit 88b19f9
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 4 deletions.
7 changes: 5 additions & 2 deletions src/engineio/async_server.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,11 @@ class AsyncServer(base_server.BaseServer):
:param ping_timeout: The time in seconds that the client waits for the
server to respond before disconnecting. The default
is 20 seconds.
:param max_http_buffer_size: The maximum size of a message. The default
is 1,000,000 bytes.
:param max_http_buffer_size: The maximum size that is accepted for incoming
messages. The default is 1,000,000 bytes. In
spite of its name, the value set in this
argument is enforced for HTTP long-polling and
WebSocket connections.
:param allow_upgrades: Whether to allow transport upgrades or not.
:param http_compression: Whether to compress packages when using the
polling transport.
Expand Down
7 changes: 5 additions & 2 deletions src/engineio/server.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,11 @@ class Server(base_server.BaseServer):
:param ping_timeout: The time in seconds that the client waits for the
server to respond before disconnecting. The default
is 20 seconds.
:param max_http_buffer_size: The maximum size of a message. The default
is 1,000,000 bytes.
:param max_http_buffer_size: The maximum size that is accepted for incoming
messages. The default is 1,000,000 bytes. In
spite of its name, the value set in this
argument is enforced for HTTP long-polling and
WebSocket connections.
:param allow_upgrades: Whether to allow transport upgrades or not. The
default is ``True``.
:param http_compression: Whether to compress packages when using the
Expand Down

0 comments on commit 88b19f9

Please sign in to comment.