ws4py - A WebSocket package for Python

Author

Sylvain Hellegouarch

Release

0.5.1

License

BSD

Source code

https://github.com/Lawouach/WebSocket-for-Python

Build status

https://travis-ci.org/Lawouach/WebSocket-for-Python

ws4py is a Python package implementing the WebSocket protocol as defined in RFC 6455.

It comes with various server and client implementations and runs on CPython 2/3, PyPy and Android.

Overview

• Requirements
• Install ws4py
• Conformance
• Browser Support
• Performances
• Credits

Tutorial

• Basics
• Client
  • Built-in
  • Tornado
  • gevent
• Server
  • CherryPy
  • gevent
  • wsgiref
  • asyncio
• Managing a pool of WebSockets
  • Polling
  • Client example
• Built-in Examples
  • Real-time chat
  • Android sensors and HTML5

Maintainer Guide

This section describes the steps to work on ws4py itself and its release process, as well as other conventions and best practices.

• Coding Rules
• Design
• Testing Overview
• Documentation process
• Release Process

Packages

• ws4py Package
  • ws4py Package
    • configure_logger
    • format_addresses
  • exc Module
    • WebSocketException
    • FrameTooLargeException
    • ProtocolException
    • UnsupportedFrameTypeException
    • TextFrameEncodingException
    • StreamClosed
    • HandshakeError
    • InvalidBytesError
  • framing Module
    • Frame
      • Frame.parser
      • Frame.build
      • Frame.mask
      • Frame.unmask
  • manager Module
    • SelectPoller
      • SelectPoller.release
      • SelectPoller.register
      • SelectPoller.unregister
      • SelectPoller.poll
    • EPollPoller
      • EPollPoller.release
      • EPollPoller.register
      • EPollPoller.unregister
      • EPollPoller.poll
    • KQueuePoller
      • KQueuePoller.release
      • KQueuePoller.register
      • KQueuePoller.unregister
      • KQueuePoller.poll
    • WebSocketManager
      • WebSocketManager.add
      • WebSocketManager.remove
      • WebSocketManager.stop
      • WebSocketManager.run
      • WebSocketManager.close_all
      • WebSocketManager.broadcast
  • messaging Module
    • Message
      • Message.single
      • Message.fragment
      • Message.completed
      • Message.extend
    • TextMessage
      • TextMessage.is_binary
      • TextMessage.is_text
    • BinaryMessage
      • BinaryMessage.is_binary
      • BinaryMessage.is_text
    • CloseControlMessage
    • PingControlMessage
    • PongControlMessage
  • streaming Module
    • Stream
      • Stream.message
      • Stream.pings
      • Stream.pongs
      • Stream.closing
      • Stream.errors
      • Stream.parser
      • Stream.text_message
      • Stream.binary_message
      • Stream.has_message
      • Stream.close
      • Stream.ping
      • Stream.pong
      • Stream.receiver
  • utf8validator Module
    • Utf8Validator
      • Utf8Validator.UTF8VALIDATOR_DFA
      • Utf8Validator.UTF8_ACCEPT
      • Utf8Validator.UTF8_REJECT
      • Utf8Validator.decode
      • Utf8Validator.reset
      • Utf8Validator.validate
  • websocket Module
    • WebSocket
      • WebSocket.stream
      • WebSocket.protocols
      • WebSocket.extensions
      • WebSocket.sock
      • WebSocket.client_terminated
      • WebSocket.server_terminated
      • WebSocket.reading_buffer_size
      • WebSocket.environ
      • WebSocket.heartbeat_freq
      • WebSocket.local_address
      • WebSocket.peer_address
      • WebSocket.opened
      • WebSocket.close
      • WebSocket.closed
      • WebSocket.terminated
      • WebSocket.connection
      • WebSocket.close_connection
      • WebSocket.ping
      • WebSocket.ponged
      • WebSocket.received_message
      • WebSocket.unhandled_error
      • WebSocket.send
      • WebSocket.once
      • WebSocket.terminate
      • WebSocket.process
      • WebSocket.run
    • EchoWebSocket
      • EchoWebSocket.received_message
    • Heartbeat
      • Heartbeat.stop
      • Heartbeat.run
  • Subpackages
    • client Package
      • client Package
        • WebSocketBaseClient
          • WebSocketBaseClient.bind_addr
          • WebSocketBaseClient.close
          • WebSocketBaseClient.connect
          • WebSocketBaseClient.handshake_headers
          • WebSocketBaseClient.handshake_request
          • WebSocketBaseClient.process_response_line
          • WebSocketBaseClient.process_handshake_header
          • WebSocketBaseClient.handshake_ok
      • geventclient Module
      • threadedclient Module
        • WebSocketClient
          • WebSocketClient.daemon
          • WebSocketClient.run_forever
          • WebSocketClient.handshake_ok
      • tornadoclient Module
        • TornadoWebSocketClient
          • TornadoWebSocketClient.connect
          • TornadoWebSocketClient.close_connection
    • server Package
      • cherrypyserver Module
        • WebSocketTool
          • WebSocketTool.upgrade
          • WebSocketTool.complete
          • WebSocketTool.cleanup_headers
          • WebSocketTool.start_handler
        • WebSocketPlugin
          • WebSocketPlugin.start
          • WebSocketPlugin.stop
          • WebSocketPlugin.handle
          • WebSocketPlugin.cleanup
          • WebSocketPlugin.broadcast
      • geventserver Module
      • wsgirefserver Module
        • WebSocketWSGIHandler
          • WebSocketWSGIHandler.setup_environ
          • WebSocketWSGIHandler.finish_response
        • WebSocketWSGIRequestHandler
          • WebSocketWSGIRequestHandler.WebSocketWSGIHandler
          • WebSocketWSGIRequestHandler.handle
        • WSGIServer
          • WSGIServer.initialize_websockets_manager
          • WSGIServer.shutdown_request
          • WSGIServer.link_websocket_to_server
          • WSGIServer.server_close
      • wsgitutils Module
        • WebSocketWSGIApplication
          • WebSocketWSGIApplication.make_websocket

Indices and tables

• Module Index

• Search Page