Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion packages/socket.io/lib/broadcast-operator.ts
Original file line number Diff line number Diff line change
Expand Up @@ -325,6 +325,14 @@ export class BroadcastOperator<EmitEvents extends EventsMap, SocketData>
ev: Ev,
...args: AllButLast<EventParams<EmitEvents, Ev>>
): Promise<FirstNonErrorArg<Last<EventParams<EmitEvents, Ev>>>> {
const defaultTimeout = this.adapter.nsp.server?.opts?.ackTimeout;
const operator =
this.flags.timeout === undefined && defaultTimeout !== undefined
? new BroadcastOperator(this.adapter, this.rooms, this.exceptRooms, {
...this.flags,
timeout: defaultTimeout,
})
: this;
return new Promise((resolve, reject) => {
args.push((err, responses) => {
if (err) {
Expand All @@ -334,7 +342,10 @@ export class BroadcastOperator<EmitEvents extends EventsMap, SocketData>
return resolve(responses);
}
});
this.emit(ev, ...(args as any[] as EventParams<EmitEvents, Ev>));
(operator as this).emit(
ev,
...(args as any[] as EventParams<EmitEvents, Ev>),
);
});
}

Expand Down
20 changes: 20 additions & 0 deletions packages/socket.io/lib/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ import {
RemoveAcknowledgements,
EventNamesWithAck,
FirstNonErrorArg,
EventNamesWithError,
} from "./typed-events";
import { patchAdapter, restoreAdapter, serveFile } from "./uws";
import corsMiddleware from "cors";
Expand Down Expand Up @@ -94,6 +95,10 @@ interface ServerOptions extends EngineOptions, AttachOptions {
* @default 45000
*/
connectTimeout: number;
/**
* the default timeout in milliseconds used when waiting for an acknowledgement
*/
ackTimeout?: number;
/**
* Whether to enable the recovery of connection state when a client temporarily disconnects.
*
Expand Down Expand Up @@ -1086,6 +1091,21 @@ export class Server<
return this.sockets.timeout(timeout);
}

/**
* Emits an event and waits for an acknowledgement from all clients.
*
* @example
* const responses = await io.emitWithAck("some-event");
*
* @return a Promise that will be fulfilled when all clients have acknowledged the event
*/
public emitWithAck<Ev extends EventNamesWithError<EmitEvents>>(
ev: Ev,
...args: AllButLast<EventParams<EmitEvents, Ev>>
): Promise<FirstNonErrorArg<Last<EventParams<EmitEvents, Ev>>>> {
return this.sockets.emitWithAck(ev, ...args);
}

/**
* Returns the matching socket instances.
*
Expand Down
18 changes: 18 additions & 0 deletions packages/socket.io/lib/namespace.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import {
EventNamesWithAck,
FirstNonErrorArg,
EventNamesWithoutAck,
EventNamesWithError,
} from "./typed-events";
import type { Client } from "./client";
import debugModule from "debug";
Expand Down Expand Up @@ -469,6 +470,23 @@ export class Namespace<
);
}

/**
* Emits an event and waits for an acknowledgement from all clients.
*
* @example
* const responses = await myNamespace.emitWithAck("some-event");
*
* @return a Promise that will be fulfilled when all clients have acknowledged the event
*/
public emitWithAck<Ev extends EventNamesWithError<EmitEvents>>(
ev: Ev,
...args: AllButLast<EventParams<EmitEvents, Ev>>
): Promise<FirstNonErrorArg<Last<EventParams<EmitEvents, Ev>>>> {
return new BroadcastOperator<EmitEvents, SocketData>(
this.adapter,
).emitWithAck(ev, ...args);
}

/**
* Sends a `message` event to all clients.
*
Expand Down