1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
|
Client
======
.. currentmodule:: websockets
Why does the client close the connection prematurely?
-----------------------------------------------------
You're exiting the context manager prematurely. Wait for the work to be
finished before exiting.
For example, if your code has a structure similar to::
async with connect(...) as websocket:
asyncio.create_task(do_some_work())
change it to::
async with connect(...) as websocket:
await do_some_work()
How do I access HTTP headers?
-----------------------------
Once the connection is established, HTTP headers are available in
:attr:`~client.WebSocketClientProtocol.request_headers` and
:attr:`~client.WebSocketClientProtocol.response_headers`.
How do I set HTTP headers?
--------------------------
To set the ``Origin``, ``Sec-WebSocket-Extensions``, or
``Sec-WebSocket-Protocol`` headers in the WebSocket handshake request, use the
``origin``, ``extensions``, or ``subprotocols`` arguments of
:func:`~client.connect`.
To override the ``User-Agent`` header, use the ``user_agent_header`` argument.
Set it to :obj:`None` to remove the header.
To set other HTTP headers, for example the ``Authorization`` header, use the
``extra_headers`` argument::
async with connect(..., extra_headers={"Authorization": ...}) as websocket:
...
In the :mod:`threading` API, this argument is named ``additional_headers``::
with connect(..., additional_headers={"Authorization": ...}) as websocket:
...
How do I force the IP address that the client connects to?
----------------------------------------------------------
Use the ``host`` argument of :meth:`~asyncio.loop.create_connection`::
await websockets.connect("ws://example.com", host="192.168.0.1")
:func:`~client.connect` accepts the same arguments as
:meth:`~asyncio.loop.create_connection`.
How do I close a connection?
----------------------------
The easiest is to use :func:`~client.connect` as a context manager::
async with connect(...) as websocket:
...
The connection is closed when exiting the context manager.
How do I reconnect when the connection drops?
---------------------------------------------
Use :func:`~client.connect` as an asynchronous iterator::
async for websocket in websockets.connect(...):
try:
...
except websockets.ConnectionClosed:
continue
Make sure you handle exceptions in the ``async for`` loop. Uncaught exceptions
will break out of the loop.
How do I stop a client that is processing messages in a loop?
-------------------------------------------------------------
You can close the connection.
Here's an example that terminates cleanly when it receives SIGTERM on Unix:
.. literalinclude:: ../../example/faq/shutdown_client.py
:emphasize-lines: 10-13
How do I disable TLS/SSL certificate verification?
--------------------------------------------------
Look at the ``ssl`` argument of :meth:`~asyncio.loop.create_connection`.
:func:`~client.connect` accepts the same arguments as
:meth:`~asyncio.loop.create_connection`.
|
