Ir para o conteúdo principal
Version: 4.x

Azure Service Bus adapter

How it works

This adapter uses Azure Service Bus service to forward messages between the nodes of a Socket.IO cluster.

The source code of this adapter can be found here.

Supported features versionSupport
Socket management4.0.0✅ YES (since version 0.1.0)
Inter-server communication4.1.0✅ YES (since version 0.1.0)
Broadcast with acknowledgements4.5.0✅ YES (since version 0.1.0)
Connection state recovery4.6.0❌ NO


npm install


import { ServiceBusClient, ServiceBusAdministrationClient } from "@azure/service-bus";
import { Server } from "";
import { createAdapter } from "";

const connectionString = "Endpoint=...";

const serviceBusClient = new ServiceBusClient(connectionString);
const serviceBusAdminClient = new ServiceBusAdministrationClient(connectionString);

const io = new Server({
adapter: createAdapter(serviceBusClient, serviceBusAdminClient)

// wait for the creation of the subscription
await io.of("/").adapter.init();



NameDescriptionDefault value
topicNameThe name of the
topicOptionsThe options used to create the topic.-
subscriptionPrefixThe prefix of the subscription (one subscription will be created per Socket.IO server in the cluster)
receiverOptionsThe options used to create the subscription.-
topicOptionsThe options used to create the receiver.-
heartbeatIntervalThe number of ms between two heartbeats.5_000
heartbeatTimeoutThe number of ms without heartbeat before we consider a node down.10_000

Latest releases

VersionRelease dateRelease notesDiff
0.1.0March 2024link-

Complete changelog