WebSocketTool Plugin for FastPluggy

The WebSocketTool plugin provides real-time WebSocket communication capabilities for FastPluggy applications. It enables bidirectional communication between the server and clients, supports message broadcasting, targeted messaging, and integrates with the task worker system for real-time task monitoring.

Table of Contents

• Installation
• Configuration
• Documentation
• Quick Start
• License

Installation

Requirements

• FastPluggy framework >=0.0.3
• UI Tools plugin >=0.0.3

Quick Start & Installation

pip install fastpluggy-websocket-tool

Configuration

The WebSocketTool plugin can be configured through the WebSocketSettings class:

Setting	Type	Default	Description
max_queue_size	int	10000	Maximum size of the message queue
enable_heartbeat	bool	True	Enable heartbeat mechanism to monitor connection health
heartbeat_interval	int	30	Seconds between heartbeat pings
heartbeat_timeout	int	60	Seconds before a connection is considered timed out

Documentation

The WebSocketTool plugin has comprehensive documentation available in the docs directory:

• Quick Start Guide - Basic examples to help you get started
• Core Components - Details about ConnectionManager, WebSocketMessage, and AsyncWidget
• WebSocket Handlers - Information about the handler registry system and event hooks
• WebSocket Message Types - Message types and naming conventions
• API Reference - WebSocket and REST API endpoints
• Widgets - Available widgets including AsyncWidget and WebSocketDetailsWidget
• Tasks Worker Integration - Integration with the Tasks Worker module
• Advanced Usage - Advanced usage, health monitoring, and troubleshooting

Quick Start

For a quick introduction to using the WebSocketTool plugin, including client-side connection examples and basic server-side usage, see the Quick Start Guide.

License

This plugin is licensed under the same license as the FastPluggy framework.