Class InMemoryEntitlementHook

Reservations in memory for tests and single-process hosts; no external billing policy is applied.

Implements

IEntitlementHook

Index

Constructors

Methods

reserve revalidate meter settle release get forget

Constructors

constructor

new InMemoryEntitlementHook(maxSeconds?): InMemoryEntitlementHook
Parameters
- maxSeconds: number = 14_400
  The most one reservation covers, in seconds; four hours when absent.
Returns InMemoryEntitlementHook
- Defined in src/io/channels/meetings/stores/memory.ts:386

Methods

reserve

reserve(input): Promise<ReserveResult>
Reserves at most maxSeconds for a run about to be made; the answer's maxSeconds is what it covers, and the run's limit is cut to it. A refusal sends no bot.
Parameters
- input: {
      ownerRef: string;
      runId: string;
      platform: MeetingPlatform;
      maxSeconds: number;
  }
  - ownerRef: string
  - runId: string
  - platform: MeetingPlatform
  - maxSeconds: number
Returns Promise<ReserveResult>
Implementation of IEntitlementHook.reserve
- Defined in src/io/channels/meetings/stores/memory.ts:387

revalidate

revalidate(id): Promise<boolean>
A scheduled run, at dispatch: still paid, still has the hours. Not asked when the hook has revalidateAllowance.
Parameters
- id: string
Returns Promise<boolean>
Implementation of IEntitlementHook.revalidate
- Defined in src/io/channels/meetings/stores/memory.ts:396

meter

meter(id, seconds): Promise<void>
The seconds the run has used so far, every minute: a running total, not an increment.
Parameters
- id: string
- seconds: number
Returns Promise<void>
Implementation of IEntitlementHook.meter
- Defined in src/io/channels/meetings/stores/memory.ts:400

settle

settle(id, billedSeconds): Promise<void>
Settles the run at the seconds it is billed.
Parameters
- id: string
- billedSeconds: number
Returns Promise<void>
Implementation of IEntitlementHook.settle
- Defined in src/io/channels/meetings/stores/memory.ts:404

release

release(id): Promise<void>
Frees a reservation nothing is billed against: a run that ends unbilled, or a send refused after its reservation.
Parameters
- id: string
Returns Promise<void>
Implementation of IEntitlementHook.release
- Defined in src/io/channels/meetings/stores/memory.ts:408

get

get(id): undefined | {
    runId: string;
    maxSeconds: number;
    metered: number;
    settled?: number;
    released: boolean;
}
A copied reservation, for inspection by a single-process host.
Parameters
- id: string
Returns undefined | {
    runId: string;
    maxSeconds: number;
    metered: number;
    settled?: number;
    released: boolean;
}
- Defined in src/io/channels/meetings/stores/memory.ts:413

forget

forget(runId): Promise<void>
Optional whole-run eviction for in-memory hosts after terminal cleanup and the retention grace. Durable stores omit it to retain their records. Call only after producers have stopped; forgetting removes fences too.
Parameters
- runId: string
Returns Promise<void>
Implementation of IEntitlementHook.forget
- Defined in src/io/channels/meetings/stores/memory.ts:417