Add a FAQ

[aaugustin]

I've been going through all issues posted to this bug tracker over the years to build a list of questions that are actually frequently asked.

Here's the result.

websockets issues

• send / receive more than one message Websocket keeps closing #83 Websocket closes its connection on access from async method #122 Websocket server restarts constantly  #148 Consumer and Producer both in code sample #152 How to keep connection alive? #398 missing messages PUSH #548 client : how to keep open connection and send messages #559 Document how to receive more than one message in the cheatsheet #564 Document sending multiple messages #591
• debugging connection establishment => logging.DEBUG
• network errors in logs ... when the network is bad, it shows fatal read error message #448

asyncio issues

• only one client can connect at a time is websockets support cocurrent? #136 Multiple clients? #187 Server is correctly responding to closing request from client #206 How to build a multi-processing websocket server? #584 why does my WS server accept only 1 connection #620
• forgot to await a coroutine ... webcocket.close() doesn't work #561
• setup, fix or disable SSL verification ... ssl error #419 How to disable ssl cert verification #480 Disable cert verification (non-crypto!) #522 How to generate new EC key and assign to websockets? #610

websockets design

• high level patterns: broadcast / subscriptions / channels / rooms Send to two clients in one server?How can I do? #17 socket.io ? #101 Usability questions #384 Question: Working with multiple clients #427 websockets rooms #481 Document how to create channels or rooms #603
• use callbacks instead of coroutines Add functions to allow proper subclassing of WebSocket*Protocol #32 add on_open() and on_close() methods, similar to tornado web socket implementation? #52 Websocket client daemon #103 How to keep session alive when using async websockets? #161 Can this be used without async/await? #173 Listen for websocket close on server side #243 How to make a longlive connection client ? #344
• interact synchronously with the API Encapsulation the API to a synchronous one #485
• WS and HTTP on the same port Document how you serve both websockets and a aiohttp server on the same port. #49 WebSockets and HTTP sharing the same port using request headers #116
• Python 2 support Python 2 version? #125 python2.7 client #191

How do I... (general, websockets)

• respond to pings How to catch a ping to send a pong #79 Unclear on how to use ping/pong mechanism #268 How can i add s5 proxy to ws , and deal with ping? #473 Auto ping/pong ,timeout,ping_timeout,event_loop  #532
• keep connections alive (now built-in and enabled by default) connection timed out after few minutes #110 Ping example in "Keeping connections open" #333 How would I modify my code to auto-ping every 2s, to avoid disconnects #446
• reconnect automatically Common pattern for reconnections #414 How to reconnect after: ConnectionClosed: code 1006 <connection closed abnormally> ? #367
• close individual client connection, server connection, server gracefully? Gracefully close long lived client. #362 The right way to close a connection. #444 Questions about consumer_handler and registration examples in intro #457
• set a timeout how to set timeout on recv()? #141

How do I... (asyncio)

• do two things at once Best practices for integration with other asyncio libraries? #37 Receive messages and periodically push data to client. #45 Document how to wait on multiple futures #48 How to query the websocket state #100 Integrating other coroutines into a producer-consumer server #247 How to open multiple clients? #382 Multiple concurrent client connections [documentation request] #490 How to send a JSON heartbeat message to the server every minute? #526
• attempts to use multiple threading How to connect many websocket? #question #343 Is it possible to run multithread server? #346
• run event loop in another thread Threaded execution #360

How do I... (specific, websockets)

• get the remote IP address Obtain the client's ip. #33 Get client addr (host and port) on server? #66 How to access Remote Ip address from websocket object? #555
• bind to a given port on the client or server side ... How could I listen to any ipv4 connections? #602
• access HTTP headers Retrieve cookies ? #82 How to get request headers on Server to Process them. #491
• sending HTTP headers Passing cookie through python websocket client #420