Skip to content

IdentifyCoordinator

Defined in: packages/sharding/src/identify.ts:69

Hands out IDENTIFY slots for a whole deployment. Every cluster asks the parent, so the limit holds across processes: one IDENTIFY per rate-limit key per interval, and no more IDENTIFYs than session_start_limit.remaining. It only does arithmetic on timestamps and holds one timer, so it can be tested with a fake clock.

new IdentifyCoordinator(options?): IdentifyCoordinator

Defined in: packages/sharding/src/identify.ts:87

IdentifyCoordinatorOptions = {}

IdentifyCoordinator

readonly maxConcurrency: number

Defined in: packages/sharding/src/identify.ts:70

get holding(): number

Defined in: packages/sharding/src/identify.ts:136

Slots granted and not yet released.

number


get remaining(): number | undefined

Defined in: packages/sharding/src/identify.ts:124

Slots left in the session budget, or undefined when it is unknown.

number | undefined


get waiting(): number

Defined in: packages/sharding/src/identify.ts:129

Requests waiting for a slot.

number

acquire(owner, shardId): Promise<void>

Defined in: packages/sharding/src/identify.ts:147

Waits for the shard’s turn. Resolves when the shard may IDENTIFY now; call release once it has. Rejects if owner is dropped or the coordinator closes first.

number

number

Promise<void>


close(): void

Defined in: packages/sharding/src/identify.ts:210

Rejects every waiter and stops the timer.

void


drop(owner, reason?): void

Defined in: packages/sharding/src/identify.ts:190

A cluster is gone: forget its waiting requests and free the slots it held.

number

string = "The cluster went away."

void


pump(): void

Defined in: packages/sharding/src/identify.ts:225

Grants every slot that is due and arms one timer for the next. Called internally and by tests after moving the clock.

void


release(owner, shardId): void

Defined in: packages/sharding/src/identify.ts:161

The shard has sent its IDENTIFY: its key rests for one interval. Ignored unless owner holds the slot.

number

number

void