socket.io-redis

constructor

constructor(nsp: any, uri: string, opts?: Partial<RedisAdapterOptions>);

• Adapter constructor.

  Parameter nsp

  the namespace

  Parameter uri

  the url of the Redis server

  Parameter opts

  the options for both the Redis adapter and the Redis client

  Modifiers

  • @public

property pubClient

readonly pubClient: any;

property requestsTimeout

readonly requestsTimeout: number;

property subClient

readonly subClient: any;

property uid

readonly uid: any;

method addSockets

addSockets: (opts: BroadcastOptions, rooms: Room[]) => void;

method allRooms

allRooms: () => Promise<Set<Room>>;

• Gets the list of all rooms (across every node)

  Modifiers

  • @public

method broadcast

broadcast: (packet: any, opts: BroadcastOptions) => void;

• Broadcasts a packet.

  Parameter packet

  packet to emit

  Parameter opts

  options

  Modifiers

  • @public

method delSockets

delSockets: (opts: BroadcastOptions, rooms: Room[]) => void;

method disconnectSockets

disconnectSockets: (opts: BroadcastOptions, close: boolean) => void;

method fetchSockets

fetchSockets: (opts: BroadcastOptions) => Promise<any[]>;

method remoteDisconnect

remoteDisconnect: (id: SocketId, close?: boolean) => Promise<void>;

• Makes the socket with the given id to be forcefully disconnected

  Parameter id

  socket id

  Parameter close

  if true, closes the underlying connection

  Modifiers

  • @public

method remoteJoin

remoteJoin: (id: SocketId, room: Room) => Promise<void>;

• Makes the socket with the given id join the room

  Parameter id

  socket id

  Parameter room

  room name

  Modifiers

  • @public

method remoteLeave

remoteLeave: (id: SocketId, room: Room) => Promise<void>;

• Makes the socket with the given id leave the room

  Parameter id

  socket id

  Parameter room

  room name

  Modifiers

  • @public

method sockets

sockets: (rooms: Set<Room>) => Promise<Set<SocketId>>;

• Gets a list of sockets by sid.

  Parameter rooms

  the explicit set of rooms to check.

property key

key: string;

• the name of the key to pub/sub events on as prefix socket.io

property pubClient

pubClient: any;

• the redis client to publish events on

property requestsTimeout

requestsTimeout: number;

• after this timeout the adapter will stop waiting from responses to request 5000

property subClient

subClient: any;

• the redis client to subscribe to events on