Skip to content

Commit 5e78ecb

Browse files
Minor updates to the server and client documentation
1 parent 469b7c0 commit 5e78ecb

File tree

4 files changed

+14
-2
lines changed

4 files changed

+14
-2
lines changed

src/socketio/async_client.py

+4-1
Original file line numberDiff line numberDiff line change
@@ -53,11 +53,14 @@ class AsyncClient(base_client.BaseClient):
5353
:param http_session: an initialized ``aiohttp.ClientSession`` object to be
5454
used when sending requests to the server. Use it if
5555
you need to add special client options such as proxy
56-
servers, SSL certificates, etc.
56+
servers, SSL certificates, custom CA bundle, etc.
5757
:param ssl_verify: ``True`` to verify SSL certificates, or ``False`` to
5858
skip SSL certificate verification, allowing
5959
connections to servers with self signed certificates.
6060
The default is ``True``.
61+
:param websocket_extra_options: Dictionary containing additional keyword
62+
arguments passed to
63+
``websocket.create_connection()``.
6164
:param engineio_logger: To enable Engine.IO logging set to ``True`` or pass
6265
a logger object to use. To disable logging set to
6366
``False``. The default is ``False``. Note that

src/socketio/async_server.py

+3
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,9 @@ class AsyncServer(base_server.BaseServer):
102102
inactive clients are closed. Set to ``False`` to
103103
disable the monitoring task (not recommended). The
104104
default is ``True``.
105+
:param transports: The list of allowed transports. Valid transports
106+
are ``'polling'`` and ``'websocket'``. Defaults to
107+
``['polling', 'websocket']``.
105108
:param engineio_logger: To enable Engine.IO logging set to ``True`` or pass
106109
a logger object to use. To disable logging set to
107110
``False``. The default is ``False``. Note that

src/socketio/client.py

+4-1
Original file line numberDiff line numberDiff line change
@@ -56,11 +56,14 @@ class Client(base_client.BaseClient):
5656
:param http_session: an initialized ``requests.Session`` object to be used
5757
when sending requests to the server. Use it if you
5858
need to add special client options such as proxy
59-
servers, SSL certificates, etc.
59+
servers, SSL certificates, custom CA bundle, etc.
6060
:param ssl_verify: ``True`` to verify SSL certificates, or ``False`` to
6161
skip SSL certificate verification, allowing
6262
connections to servers with self signed certificates.
6363
The default is ``True``.
64+
:param websocket_extra_options: Dictionary containing additional keyword
65+
arguments passed to
66+
``websocket.create_connection()``.
6467
:param engineio_logger: To enable Engine.IO logging set to ``True`` or pass
6568
a logger object to use. To disable logging set to
6669
``False``. The default is ``False``. Note that

src/socketio/server.py

+3
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,9 @@ class Server(base_server.BaseServer):
106106
inactive clients are closed. Set to ``False`` to
107107
disable the monitoring task (not recommended). The
108108
default is ``True``.
109+
:param transports: The list of allowed transports. Valid transports
110+
are ``'polling'`` and ``'websocket'``. Defaults to
111+
``['polling', 'websocket']``.
109112
:param engineio_logger: To enable Engine.IO logging set to ``True`` or pass
110113
a logger object to use. To disable logging set to
111114
``False``. The default is ``False``. Note that

0 commit comments

Comments
 (0)