Welcome to websocket-client’s documentation

Introduction:

• Installation
• Getting Started
• Examples
  • Creating Your First WebSocket Connection
  • Debug and Logging Options
  • Using websocket-client with “with” statements
  • Connection Options
  • Dispatching Multiple WebSocketApps
  • README Examples
  • Real-world Examples
• Threading
  • Importance of enable_multithread
  • asyncio library usage
  • threading library usage
  • Possible issues with threading
• FAQ
  • What about Python 2 support?
  • Why is this library slow?
  • How to troubleshoot an unclear callback error?
  • How to solve the “connection is already closed” error?
  • What’s going on with the naming of this library?
  • Is WebSocket Compression using the permessage-deflate extension supported?
  • I get the error ‘utf8’ codec can’t decode byte 0x81 in position 0
  • If a connection is re-established after getting disconnected, does the new connection continue where the previous one dropped off?
  • What is the difference between recv_frame(), recv_data_frame(), and recv_data()?
  • How to disable ssl cert verification?
  • How to disable hostname verification?
  • What else can I do with sslopts?
  • How to enable SNI?
  • Why don’t I receive all the server’s message(s)?
  • Using Subprotocols
• Contributing
• About

Comments Embedded in Code:

• websocket/_abnf.py
  • ABNF
• websocket/_app.py
  • WebSocketApp
• websocket/_core.py
  • WebSocket
  • create_connection()
• websocket/_exceptions.py
  • WebSocketAddressException
  • WebSocketBadStatusException
  • WebSocketConnectionClosedException
  • WebSocketException
  • WebSocketPayloadException
  • WebSocketProtocolException
  • WebSocketProxyException
  • WebSocketTimeoutException
• websocket/_logging.py
  • enableTrace()
• websocket/_socket.py
  • getdefaulttimeout()
  • setdefaulttimeout()
• websocket/_url.py
  • get_proxy_info()
  • parse_url()

Indices and tables

• Index

• Module Index