Browse Source

docs: add serializer_args

pull/1521/head
phi 7 months ago
parent
commit
81e96142f9
  1. 3
      src/socketio/async_client.py
  2. 3
      src/socketio/async_server.py
  3. 3
      src/socketio/client.py
  4. 3
      src/socketio/server.py

3
src/socketio/async_client.py

@ -45,6 +45,9 @@ class AsyncClient(base_client.BaseClient):
leave interrupt handling to the calling application. leave interrupt handling to the calling application.
Interrupt handling can only be enabled when the Interrupt handling can only be enabled when the
client instance is created in the main thread. client instance is created in the main thread.
:param serializer_args: A mapping of additional parameters to pass to
the serializer. The content of this dictionary
depends on the selected serialization method.
The Engine.IO configuration supports the following settings: The Engine.IO configuration supports the following settings:

3
src/socketio/async_server.py

@ -50,6 +50,9 @@ class AsyncServer(base_server.BaseServer):
default is `['/']`, which always accepts connections to default is `['/']`, which always accepts connections to
the default namespace. Set to `'*'` to accept all the default namespace. Set to `'*'` to accept all
namespaces. namespaces.
:param serializer_args: A mapping of additional parameters to pass to
the serializer. The content of this dictionary
depends on the selected serialization method.
:param kwargs: Connection parameters for the underlying Engine.IO server. :param kwargs: Connection parameters for the underlying Engine.IO server.
The Engine.IO configuration supports the following settings: The Engine.IO configuration supports the following settings:

3
src/socketio/client.py

@ -48,6 +48,9 @@ class Client(base_client.BaseClient):
leave interrupt handling to the calling application. leave interrupt handling to the calling application.
Interrupt handling can only be enabled when the Interrupt handling can only be enabled when the
client instance is created in the main thread. client instance is created in the main thread.
:param serializer_args: A mapping of additional parameters to pass to
the serializer. The content of this dictionary
depends on the selected serialization method.
The Engine.IO configuration supports the following settings: The Engine.IO configuration supports the following settings:

3
src/socketio/server.py

@ -53,6 +53,9 @@ class Server(base_server.BaseServer):
default is `['/']`, which always accepts connections to default is `['/']`, which always accepts connections to
the default namespace. Set to `'*'` to accept all the default namespace. Set to `'*'` to accept all
namespaces. namespaces.
:param serializer_args: A mapping of additional parameters to pass to
the serializer. The content of this dictionary
depends on the selected serialization method.
:param kwargs: Connection parameters for the underlying Engine.IO server. :param kwargs: Connection parameters for the underlying Engine.IO server.
The Engine.IO configuration supports the following settings: The Engine.IO configuration supports the following settings:

Loading…
Cancel
Save