Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
@socket.io/sticky
Advanced tools
Changelog
Readme
A simple and performant way to use Socket.IO within a cluster.
Unlike other packages like sticky-session, the routing is based on the session ID (the sid
query parameter).
See also:
connection.remoteAddress
)x-forwarded-for
header)Table of contents
npm install @socket.io/sticky
const cluster = require("cluster");
const http = require("http");
const { Server } = require("socket.io");
const numCPUs = require("os").cpus().length;
const { setupMaster, setupWorker } = require("@socket.io/sticky");
const { createAdapter, setupPrimary } = require("@socket.io/cluster-adapter");
if (cluster.isMaster) {
console.log(`Master ${process.pid} is running`);
const httpServer = http.createServer();
setupMaster(httpServer, {
loadBalancingMethod: "least-connection", // either "random", "round-robin" or "least-connection"
});
setupPrimary();
httpServer.listen(3000);
for (let i = 0; i < numCPUs; i++) {
cluster.fork();
}
cluster.on("exit", (worker) => {
console.log(`Worker ${worker.process.pid} died`);
cluster.fork();
});
} else {
console.log(`Worker ${process.pid} started`);
const httpServer = http.createServer();
const io = new Server(httpServer);
io.adapter(createAdapter());
setupWorker(io);
io.on("connection", (socket) => {
/* ... */
});
}
The first HTTP request (without sid
query parameter) is forwarded to a random worker (based on the loadBalancingMethod
option).
The underlying Engine.IO server creates a new session and emits a connection
event with the session ID. The worker sends this session ID to the master, which stores the relationship between the worker ID and the session ID.
For subsequent requests, the sid
query parameter is extracted by the master process, which then forwards the handle to the right worker.
// client-side
const socket = io({
transports: ["websocket"] // HTTP long-polling is disabled
});
For more information, please see this issue.
MIT
FAQs
An alternative to the sticky-session package (https://github.com/indutny/sticky-session)
The npm package @socket.io/sticky receives a total of 6,898 weekly downloads. As such, @socket.io/sticky popularity was classified as popular.
We found that @socket.io/sticky demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.