Flask-SocketIO

Flask-SocketIO gives Flask applications access to low latency bi-directional communications between the clients and the server. The client-side application can use any of the SocketIO client libraries in Javascript, Python, C++, Java and Swift, or any other compatible client to establish a permanent connection to the server.

• Introduction
  • Installation
  • Requirements
  • Version compatibility
• Getting Started
  • Initialization
  • Receiving Messages
  • Sending Messages
  • Broadcasting
  • Rooms
  • Connection Events
  • Class-Based Namespaces
  • Error Handling
  • Debugging and Troubleshooting
• Implementation Notes
  • Access to Flask’s Context Globals
  • Authentication
    • Using Flask-Login with Flask-SocketIO
• Deployment
  • Embedded Server
  • Gunicorn Web Server
  • uWSGI Web Server
  • Using nginx as a WebSocket Reverse Proxy
  • Using Multiple Workers
  • Emitting from an External Process
  • Cross-Origin Controls
• Upgrading to Flask-SocketIO 5.x from the 4.x releases
• API Reference
  • SocketIO
    • SocketIO.on()
    • SocketIO.on_error()
    • SocketIO.on_error_default()
    • SocketIO.on_event()
    • SocketIO.event()
    • SocketIO.emit()
    • SocketIO.call()
    • SocketIO.send()
    • SocketIO.close_room()
    • SocketIO.run()
    • SocketIO.stop()
    • SocketIO.start_background_task()
    • SocketIO.sleep()
    • SocketIO.test_client()
  • emit()
  • send()
  • join_room()
  • leave_room()
  • close_room()
  • rooms()
  • disconnect()
  • Namespace
    • Namespace.trigger_event()
    • Namespace.emit()
    • Namespace.send()
    • Namespace.close_room()
  • SocketIOTestClient
    • SocketIOTestClient.is_connected()
    • SocketIOTestClient.connect()
    • SocketIOTestClient.disconnect()
    • SocketIOTestClient.emit()
    • SocketIOTestClient.send()
    • SocketIOTestClient.get_received()

• Index

• Module Index

• Search Page