socketio/socket.io-client
Socket.io Client
Socket.IO Client is a real-time WebSocket client library that establishes persistent bidirectional connections to a server, with automatic fallback to HTTP long-polling when WebSocket connections are unavailable. It provides an event-based bidirectional messaging framework where clients and servers exchange named events with serializable data, supporting acknowledgements and timeouts for reliable communication.
The client distinguishes itself through automatic reconnection with exponential backoff, maintaining connection reliability by monitoring health and reconnecting with increasing delays to handle transient network failures gracefully. It supports namespace-isolated communication channels, allowing a single connection to be partitioned into logical namespaces for separating application logic and authorization boundaries. The library also includes a buffer-and-replay packet queue that queues outgoing packets during disconnection and replays them in order upon successful reconnection, along with volatile event dropping for non-critical messages that can be silently discarded when the socket is disconnected or the transport is congested.
Additional capabilities include cross-origin connection support for connecting to servers from different domains, event acknowledgment with optional timeout handling, and the ability to broadcast events to all connected clients or room subsets across multiple server instances. The client also provides debug logging with scoped output for troubleshooting, and supports stripping debug instrumentation from production bundles to reduce payload size.
Features
- Real-Time Connections - Establishes real-time bidirectional connections to servers using WebSocket or HTTP long-polling with automatic reconnection.
- Real-Time Communication - Establishes low-latency bidirectional connections with automatic transport fallback and reconnection for real-time communication.
- Cross-Origin Server Connections - Accept a server URL to establish a real-time connection across origins, requiring CORS to be enabled on the server.
- Named Event Messaging Frameworks - Provides a framework for sending and receiving named events with acknowledgements over real-time connections.
- Named Event Transmissions - Implements named event transmission with arbitrary data payloads between client and server in real time.
- Custom Event Emissions - Sends custom events to the server and handles incoming events using a publish-subscribe pattern.
- Namespace-Based Communication - Partitions a single connection into logical namespaces to separate application logic and authorization boundaries.
- Client-to-Server Event Emission - Enables emitting named events with serializable data from client to server, with optional acknowledgement.
- Namespace Connectivity - Allows specifying a namespace path in the connection URL to isolate communication channels within the same server.
- Server-to-Client Event Emissions - Ships a server-to-client event emission system for broadcasting messages to all connected clients or room subsets.
- Automatic Reconnection Logic - Implements automatic reconnection with exponential backoff to restore dropped connections without manual intervention.
- WebSocket and Fallback Connection Establishment - Establishes WebSocket connections and transparently falls back to HTTP long-polling when WebSockets are unavailable.
- Namespace Multiplexing - Provides namespace multiplexing to isolate communication channels on a single socket connection.
- WebSocket and HTTP Fallback Transports - Automatically selects the best available transport and falls back to HTTP long-polling when WebSocket connections fail.
- Client-Side Event Listeners - Implements client-side event listeners that execute callbacks when named server events arrive.
- WebSocket Clients - Establishes persistent bidirectional WebSocket connections with automatic HTTP long-polling fallback.
- Real-Time Namespace Channels - Splits application logic over a single connection using namespaces to create isolated communication channels.
- Namespace-Based Isolation - Splits application logic over a single connection by creating separate channels, such as an admin area for authorized users.
- Event-Driven Frameworks - Provides an event-driven framework for sending and receiving named events with acknowledgements over real-time connections.
- Named Event Exchanges - Provides event-based bidirectional messaging with named events, acknowledgements, and timeouts over a persistent connection.
- Cross-Instance Event Broadcasting - Routes real-time events to all connected clients across multiple server instances for horizontal scaling.
- Multi-Instance Event Broadcasting - Routes real-time events to all connected clients or room subsets across multiple server instances.
- Cross-Origin Client Connections - Supports connecting to servers from different domains with proper CORS configuration.
- Event Acknowledgement Strategies - Sends events and waits for a response from the receiver, with an optional timeout for unacknowledged messages.
- Acknowledgment Timeouts - Provides event acknowledgment with optional timeout handling for unacknowledged messages.
- Volatile Event Emission - Marks events as volatile so they are silently discarded when the socket is disconnected or the transport is congested.
- Disconnection Buffers - Queues outgoing packets during disconnection and replays them in order upon successful reconnection.
- External Process Emissions - Allows external Node.js processes to broadcast packets to all connected clients via the adapter's emitter package.
- Long-Polling Event Pushing - Automatically downgrades to HTTP long-polling when WebSocket or WebTransport connections cannot be established.
- PID Namespace Isolation - Partitions a single connection into isolated logical namespaces for separating application logic and authorization boundaries.
- Scoped Console Debug Logging - Prints scoped debug messages to the browser console when enabled via a storage flag for troubleshooting.
- Message Broadcasting Adapters - Provides a pluggable adapter interface for external processes to broadcast events to all connected clients.
- Scoped Client-Side Debug Logging - Prints debug messages to the browser console filtered by scope to aid development and troubleshooting.
- Debug Log Filters - Filters debug output to specific modules using wildcards and scope names separated by commas.
- Debug Logging Management - Activates scoped debug output via environment variable or storage flag to inspect internal module activity.
