Skip to content

Commit

Permalink
Documented protocol defaults
Browse files Browse the repository at this point in the history
  • Loading branch information
miguelgrinberg committed Aug 14, 2017
1 parent 2faa6f5 commit 187c525
Showing 1 changed file with 16 additions and 9 deletions.
25 changes: 16 additions & 9 deletions socketio/server.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@ class Server(object):
is stored in an in-memory structure, so the use of
multiple connected servers is not possible.
:param logger: To enable logging set to ``True`` or pass a logger object to
use. To disable logging set to ``False``.
use. To disable logging set to ``False``. The default is
``False``.
:param binary: ``True`` to support binary payloads, ``False`` to treat all
payloads as text. On Python 2, if this is set to ``True``,
``unicode`` values are treated as text, and ``str`` and
Expand All @@ -48,26 +49,32 @@ class Server(object):
The first async mode that has all its dependencies
installed is then one that is chosen.
:param ping_timeout: The time in seconds that the client waits for the
server to respond before disconnecting.
server to respond before disconnecting. The default
is 60 seconds.
:param ping_interval: The interval in seconds at which the client pings
the server.
the server. The default is 25 seconds.
:param max_http_buffer_size: The maximum size of a message when using the
polling transport.
:param allow_upgrades: Whether to allow transport upgrades or not.
polling transport. The default is 100,000,000
bytes.
:param allow_upgrades: Whether to allow transport upgrades or not. The
default is ``True``.
:param http_compression: Whether to compress packages when using the
polling transport.
polling transport. The default is ``True``.
:param compression_threshold: Only compress messages when their byte size
is greater than this value.
is greater than this value. The default is
1024 bytes.
:param cookie: Name of the HTTP cookie that contains the client session
id. If set to ``None``, a cookie is not sent to the client.
The default is ``'io'``.
:param cors_allowed_origins: List of origins that are allowed to connect
to this server. All origins are allowed by
default.
:param cors_credentials: Whether credentials (cookies, authentication) are
allowed in requests to this server.
allowed in requests to this server. The default is
``True``.
:param engineio_logger: To enable Engine.IO logging set to ``True`` or pass
a logger object to use. To disable logging set to
``False``.
``False``. The default is ``False``.
"""
def __init__(self, client_manager=None, logger=False, binary=False,
json=None, async_handlers=False, **kwargs):
Expand Down

0 comments on commit 187c525

Please sign in to comment.