Class RequestHandler

Handles synchronous request/response (RPC) communication via Redis Pub/Sub. Automatically manages correlation IDs, timeouts, subscription lifecycle, and error routing. *

Example

const handler = new RequestHandler();
await handler.initialize(redisClient);

// Send a request to another microservice
const response = await handler.send(
RankedRequest.RequestVoiceStateSync,
{ channelIds: ["123"] },
publisherRedis
);

// Listen for incoming requests
await handler.onRequest(
RankedRequest.RequestVoiceStateSync,
async (payload) => {
return { success: true };
}
);

Index

Constructors

constructor

Methods

destroy initialize onRequest send

Constructors

constructor

new RequestHandler(config?: RequestHandlerConfig): RequestHandler
Parameters
- config: RequestHandlerConfig = {}
Returns RequestHandler
- Defined in packages/sdk/src/request/request.handler.ts:97

Methods

destroy

destroy(): Promise<void>
Gracefully terminates all pending requests and releases Redis subscriptions. Recommended during application teardown to prevent memory leaks.

Returns Promise<void>
- Defined in packages/sdk/src/request/request.handler.ts:179

initialize

initialize(responseRedis: Redis, publisherRedis: Redis): void
Mounts the active Redis connection to listen for incoming requests and responses. Must be called prior to sending or receiving any RPC. *
Parameters
- responseRedis: Redis
  The Redis client dedicated to Pub/Sub subscriptions.
- publisherRedis: Redis
Returns void
- Defined in packages/sdk/src/request/request.handler.ts:107

onRequest

onRequest<K extends RankedRequest>(
    requestType: K,
    handler: (
        payload: RankedRequestPayloads[K],
    ) => Promise<RankedRequestResponses[K]>,
): Promise<void>
Registers an asynchronous handler to process incoming requests of a specific type. *
Type Parameters
- K extends RankedRequest
  The specific request pattern type.
Parameters
- requestType: K
  The request identifier to listen for.
- handler: (payload: RankedRequestPayloads[K]) => Promise<RankedRequestResponses[K]>
  The callback executed when the request is received.
Returns Promise<void>
- Defined in packages/sdk/src/request/request.handler.ts:163

send

send<K extends RankedRequest>(
    requestType: K,
    payload: RankedRequestPayloads[K],
    publisherRedis: Redis,
): Promise<RankedRequestResponses[K]>
Dispatches a typed request to the network and waits for the corresponding response. *
Type Parameters
- K extends RankedRequest
  The specific request pattern type.
Parameters
- requestType: K
  The unique identifier of the request.
- payload: RankedRequestPayloads[K]
  The strongly typed data to send.
- publisherRedis: Redis
  The Redis client used strictly for publishing.
Returns Promise<RankedRequestResponses[K]>
A promise resolving to the strongly typed response data.

Throws
If the request exceeds the configured timeout or the remote handler fails.
- Defined in packages/sdk/src/request/request.handler.ts:121

Class RequestHandler

Example

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns RequestHandler

Methods

destroy

Returns Promise<void>

initialize

Parameters

Returns void

onRequest

Type Parameters

Parameters

Returns Promise<void>

send

Type Parameters

Parameters

Returns Promise<RankedRequestResponses[K]>

Throws

Settings

On This Page