- Review of Basics
- Node js - Quick Recap of Beginner Concepts
- Node js - Setting Up the Development Environment
- Advanced JavaScript Concept
- Javascript - Advanced Functions
- Javascript - Object-Oriented JavaScript
- Javascript - Asynchronous Patterns
- Express.js
- Express js - Introduction to Express.js
- Express js - Building RESTful APIs
- Working with Databases
- MongoDB - Connecting to MongoDB with Mongoose
- MongoDB - Defining Schemas and Models
- MongoDB - Performing CRUD Operations
- MongoDB - SQL Databases
- Authentication and Authorization in Node js
- Node js - Authentication
- Node js - Access Control
- Real-Time Applications
- Introduction to WebSocket
- Building a WebSocket server
- Introduction to Socket.io
- Setting Up Socket.io
- Intermediate Project
- Simple Task Management Application
- Conclusions
- Node js - Conclusion
Building a WebSocket server
Building a WebSocket Server
WebSocket is a protocol that enables two-way, persistent communication channels over a single TCP connection. Unlike HTTP, which follows a request-response model, WebSocket allows both the server and client to send messages to each other independently. This makes it perfect for real-time applications like chat systems, online games, collaborative editing tools, and live dashboards.
Installing Required Packages
To create a WebSocket server in Node.js, we will use the popular ws package, which is a simple and efficient WebSocket implementation.
Step 1: Initialize a Node.js Project
npm init -yStep 2: Install the ws Library
npm install wsCreating a Basic WebSocket Server
Below is a minimal example of a WebSocket server using the ws package.
const WebSocket = require('ws');
const wss = new WebSocket.Server({ port: 8080 });
wss.on('connection', function connection(ws) {
console.log('Client connected');
ws.on('message', function incoming(message) {
console.log('Received:', message);
ws.send('Server received: ' + message);
});
ws.on('close', function close() {
console.log('Client disconnected');
});
});
console.log('WebSocket server is running on ws://localhost:8080');Handling Multiple Clients
The WebSocket.Server instance keeps track of all clients connected to the server. You can broadcast messages to all clients using the wss.clients set.
Broadcast Example
wss.on('connection', function connection(ws) {
ws.on('message', function incoming(message) {
wss.clients.forEach(function each(client) {
if (client.readyState === WebSocket.OPEN) {
client.send('Broadcast: ' + message);
}
});
});
});Creating a WebSocket Client (Browser)
To test the server, you can create a simple HTML client that connects to the WebSocket server.
HTML + JavaScript Client
<!DOCTYPE html>
<html>
<head>
<title>WebSocket Client</title>
</head>
<body>
<h1>WebSocket Client</h1>
<input id="messageInput" placeholder="Type a message" />
<button onclick="sendMessage()">Send</button>
<div id="messages"></div>
<script>
const socket = new WebSocket('ws://localhost:8080');
socket.onopen = () => {
console.log('Connected to server');
};
socket.onmessage = (event) => {
const messages = document.getElementById('messages');
const newMessage = document.createElement('p');
newMessage.textContent = event.data;
messages.appendChild(newMessage);
};
function sendMessage() {
const input = document.getElementById('messageInput');
socket.send(input.value);
input.value = '';
}
</script>
</body>
</html>Error Handling
Handling Connection Errors
wss.on('error', function error(err) {
console.error('WebSocket server error:', err);
});Client-Side Error Events
socket.onerror = function(event) {
console.error('WebSocket error:', event);
};Secure WebSocket (wss)
For production environments, it's recommended to use secure WebSocket connections (wss), which are encrypted via TLS/SSL.
Using HTTPS with WebSocket
const fs = require('fs');
const https = require('https');
const WebSocket = require('ws');
const server = https.createServer({
cert: fs.readFileSync('path/to/cert.pem'),
key: fs.readFileSync('path/to/key.pem')
});
const wss = new WebSocket.Server({ server });
wss.on('connection', function connection(ws) {
ws.on('message', function(message) {
ws.send('Secure Echo: ' + message);
});
});
server.listen(8443);Useful WebSocket Events
- open: Fired when the connection is established
- message: Fired when a message is received
- close: Fired when the connection is closed
- error: Fired when an error occurs
Real-Time Use Cases for WebSocket Servers
- Live chat messaging
- Real-time stock price updates
- Collaborative document editing
- Online gaming
- IoT communication
Building a WebSocket server with Node.js and the ws library is straightforward and powerful. WebSockets allow real-time, two-way communication with minimal overhead, making them ideal for modern applications that demand low latency and high interactivity. As your application scales, you can integrate WebSocket with load balancers, Redis pub/sub, and message queues to build robust and scalable real-time systems.
