Socket.IO AWS SQS adapter

The @socket.io/aws-sqs-adapter package allows broadcasting packets between multiple Socket.IO servers.

Unlike the existing socket.io-sqs package, this package supports binary payloads and dynamic namespaces.

Table of contents

• Supported features
• Installation
• Usage
• Options
• License

Supported features

Feature	socket.io version	Support
Socket management	4.0.0	✅ YES (since version 0.1.0)
Inter-server communication	4.1.0	✅ YES (since version 0.1.0)
Broadcast with acknowledgements	4.5.0	✅ YES (since version 0.1.0)
Connection state recovery	4.6.0	❌ NO

Installation

npm install @socket.io/aws-sqs-adapter

Usage

import { SNS } from "@aws-sdk/client-sns";
import { SQS } from "@aws-sdk/client-sqs";
import { Server } from "socket.io";
import { createAdapter } from "@socket.io/aws-sqs-adapter";

const snsClient = new SNS();
const sqsClient = new SQS();

const io = new Server({
  adapter: createAdapter(snsClient, sqsClient)
});

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

const gracefulShutdown = async () => {
  // wait for the deletion of the SQS queue and the SNS subscription
  await io.close();
};

process.once("SIGINT", gracefulShutdown);
process.once("SIGTERM", gracefulShutdown);

io.listen(3000);

Options

Name	Description	Default value
topicArn	The ARN of an existing SNS topic to reuse.	-
topicName	The name of the SNS topic. Ignored if topicArn is provided.	socket-io
topicTags	The tags to apply to the new SNS topic. Ignored if topicArn is provided.	-
queueName	A function used to generate the SQS queue name from its random ID.	-
queuePrefix	The prefix of the SQS queue. Ignored if queueName is provided.	socket-io
queueTags	The tags to apply to the new SQS queue.	-
sqsMaxNumberOfMessages	The maximum number of messages to return.	10
sqsWaitTimeSeconds	The duration (in seconds) for which the call waits for a message to arrive in the queue before returning.	5
heartbeatInterval	The number of ms between two heartbeats.	5_000
heartbeatTimeout	The number of ms without heartbeat before we consider a node down.	10_000

License

MIT