Class MongodbSemaphoreAdapter

To utilize the MongodbSemaphoreAdapter, you must install the "mongodb" package.

Note in order to use MongodbSemaphoreAdapter correctly, ensure you use a single, consistent database across all server instances.

IMPORT_PATH: "@daiso-tech/core/semaphore/mongodb-semaphore-adapter"

Implements

Index

Constructors

constructor

Methods

acquire deInit forceReleaseAll getState init refresh release

Constructors

constructor

new MongodbSemaphoreAdapter(
settings: MongodbSemaphoreAdapterSettings,
): MongodbSemaphoreAdapter

Parameters

settings: MongodbSemaphoreAdapterSettings

Returns MongodbSemaphoreAdapter

Example

import { MongodbSemaphoreAdapter } from "@daiso-tech/core/semaphore/mongodb-semaphore-adapter";
import { MongoClient } from "mongodb";

const client = await MongoClient.connect("YOUR_MONGODB_CONNECTION_STRING");
const database = client.db("database");
const semaphoreAdapter = new MongodbSemaphoreAdapter({
  database
});
// You need initialize the adapter once before using it.
await semaphoreAdapter.init()

Methods

acquire

acquire(settings: SemaphoreAcquireSettings): Promise<boolean>
Attempts to acquire a slot in the semaphore. Succeeds only if the current number of acquired slots has not reached the limit.
Parameters
- settings: SemaphoreAcquireSettings
  Settings containing the context, key, slotId, limit, and ttl for the acquisition
Returns Promise<boolean>
Promise resolving to true if the slot was successfully acquired, false if the slot limit has been reached
Implementation of ISemaphoreAdapter.acquire
- Defined in src/semaphore/implementations/adapters/mongodb-semaphore-adapter/mongodb-semaphore-adapter.ts:244

deInit

deInit(): Promise<void>
Removes the collection where the semaphore keys are stored and all it's related indexes. Note all semaphore data will be removed.

Returns Promise<void>
Implementation of IDeinitizable.deInit
- Defined in src/semaphore/implementations/adapters/mongodb-semaphore-adapter/mongodb-semaphore-adapter.ts:136

forceReleaseAll

forceReleaseAll(_context: IReadableContext, key: string): Promise<boolean>
Forcibly releases all slots for the specified semaphore regardless of ownership. Used for emergency cleanup or administrative operations. Bypasses ownership verification for situations where individual slot holders are unavailable.
Parameters
- _context: IReadableContext
- key: string
  Unique identifier for the semaphore
Returns Promise<boolean>
Promise resolving to true if the semaphore existed and slots were released, false if the semaphore doesn't exist or has no acquired slots
Implementation of ISemaphoreAdapter.forceReleaseAll
- Defined in src/semaphore/implementations/adapters/mongodb-semaphore-adapter/mongodb-semaphore-adapter.ts:410

getState

getState(
_context: IReadableContext,
key: string,
): Promise<null | ISemaphoreAdapterState>
Retrieves the current state of a semaphore.
Parameters
- _context: IReadableContext
- key: string
  Unique identifier for the semaphore
Returns Promise<null | ISemaphoreAdapterState>
Promise resolving to the non-expired semaphore state if it exists; otherwise null for missing or expired semaphores
Implementation of ISemaphoreAdapter.getState
- Defined in src/semaphore/implementations/adapters/mongodb-semaphore-adapter/mongodb-semaphore-adapter.ts:499

init

init(): Promise<void>
Initializes the object. Performs any async setup required before the object is usable. Should prepare internal state and verify system dependencies.

Returns Promise<void>
Void promise (resolves when initialization complete)

Throws
Error if initialization fails (e.g., connection timeout, validation error)
Implementation of IInitizable.init
- Defined in src/semaphore/implementations/adapters/mongodb-semaphore-adapter/mongodb-semaphore-adapter.ts:109

refresh

refresh(
    _context: IReadableContext,
    key: string,
    slotId: string,
    ttl: TimeSpan,
): Promise<boolean>
Refreshes (extends) the time-to-live of an existing slot. Only succeeds if all conditions are met: the slot exists, hasn't expired, and is expirable.
Parameters
- _context: IReadableContext
- key: string
  Unique identifier for the semaphore
- slotId: string
  Unique identifier of the slot to refresh
- ttl: TimeSpan
  New time-to-live duration to set
Returns Promise<boolean>
Promise resolving to true if refresh succeeded, false if the slot is unexpirable, expired, or doesn't exist
Implementation of ISemaphoreAdapter.refresh
- Defined in src/semaphore/implementations/adapters/mongodb-semaphore-adapter/mongodb-semaphore-adapter.ts:432

release

release(
    _context: IReadableContext,
    key: string,
    slotId: string,
): Promise<boolean>
Releases a specific slot if it is currently acquired. Only the holder of the slot (identified by slotId) can release it.
Parameters
- _context: IReadableContext
- key: string
  Unique identifier for the semaphore
- slotId: string
  Unique identifier of the slot to release
Returns Promise<boolean>
Promise resolving to true if the slot was successfully released, false if the slot doesn't exist or is already released
Implementation of ISemaphoreAdapter.release
- Defined in src/semaphore/implementations/adapters/mongodb-semaphore-adapter/mongodb-semaphore-adapter.ts:361

Class MongodbSemaphoreAdapter

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns MongodbSemaphoreAdapter

Example

Methods

acquire

Parameters

Returns Promise<boolean>

deInit

Returns Promise<void>

forceReleaseAll

Parameters

Returns Promise<boolean>

getState

Parameters

Returns Promise<null | ISemaphoreAdapterState>

init

Returns Promise<void>

Throws

refresh

Parameters

Returns Promise<boolean>

release

Parameters

Returns Promise<boolean>

Settings

On This Page