How websockets/ws works
ws is a Node.js WebSocket client and server library. A client initiates a connection or a server accepts an HTTP upgrade; the WebSocket runtime then sends and receives protocol frames and exposes messages, events, and an optional stream interface. Server-side handshake negotiation includes subprotocols and optional permessage-deflate compression. The graph reflects the sampled runtime modules and README capabilities; unsampled internals are represented only where the tree or README supports them, so some relationships are intentionally omitted.
Main entry points: websocket.js WebSocket API · websocket-server.js Server Upgrade · receiver.js Frame Receiver · permessage-deflate.js Message Compression
Components 16
Public API
- WebSocket API
lib/websocket.js - WebSocket Server
lib/websocket-server.js - Stream Adapter
lib/stream.js
Connection Handshake
- Client Handshake
lib/websocket.js - Server Upgrade
lib/websocket-server.js - Extension Negotiation
lib/extension.js - Subprotocols
lib/subprotocol.js
WebSocket Protocol
- Frame Sender
lib/sender.js - Frame Receiver
lib/receiver.js - Message Compression
lib/permessage-deflate.js - Event Target
lib/event-target.js
Runtime Support
- Buffer Utilities
lib/buffer-util.js - Protocol Validation
lib/validation.js - Zlib Limiter
lib/limiter.js
Other components
- Application
- Node HTTP/S
Connections 22
- Application → WebSocket API: opens client
README.md - Application → WebSocket Server: creates server
README.md - WebSocket API → Client Handshake: initiates
lib/websocket.js - Node HTTP/S → WebSocket Server: provides upgrades
lib/websocket-server.js - WebSocket Server → Server Upgrade: handles upgrades
lib/websocket-server.js - Server Upgrade → WebSocket API: creates connection
lib/websocket-server.js - Server Upgrade → Extension Negotiation: negotiates extensions
lib/websocket-server.js - Server Upgrade → Subprotocols: parses protocols
lib/websocket-server.js - WebSocket API → Frame Sender: sends frames
lib/websocket.js - WebSocket API → Frame Receiver: receives frames
lib/websocket.js - Frame Sender → Message Compression: compresses payloads
lib/sender.js - Frame Receiver → Message Compression: inflates payloads
lib/receiver.js - Frame Sender → Buffer Utilities: masks data
lib/sender.js - Frame Receiver → Buffer Utilities: unmasks data
lib/receiver.js - Frame Receiver → Protocol Validation: validates frames
lib/receiver.js - Subprotocols → Protocol Validation: uses tokens
lib/subprotocol.js - Extension Negotiation → Protocol Validation: uses tokens
lib/extension.js - Message Compression → Buffer Utilities: joins buffers
lib/permessage-deflate.js - Message Compression → Zlib Limiter: limits concurrency
lib/permessage-deflate.js - WebSocket API → Event Target: exposes events
lib/websocket.js - WebSocket API → Stream Adapter: adapts connection
lib/stream.js - WebSocket API → Extension Negotiation: uses extensions
lib/websocket.js