Class LockManager

Manages the acquisition and renewal of locks.

Index

Constructors

Accessors

logger renewalService

Methods

Constructors

constructor

new LockManager(
    _renewalService?: LockRenewalService,
    _logger?: SoloLogger,
    k8Factory?: K8Factory,
    configManager?: ConfigManager,
    remoteConfigRuntimeState?: RemoteConfigRuntimeStateApi,
): LockManager
Creates a new lock manager.
Parameters
- Optional_renewalService: LockRenewalService
  the lock renewal service.
- Optional_logger: SoloLogger
  the logger.
- Optionalk8Factory: K8Factory
  the Kubernetes client.
- OptionalconfigManager: ConfigManager
  the configuration manager.
- OptionalremoteConfigRuntimeState: RemoteConfigRuntimeStateApi
Returns LockManager
- Defined in src/core/lock/lock-manager.ts:31

Accessors

logger

get logger(): SoloLogger
Retrieves the logger instance.

Returns SoloLogger
the logger.
- Defined in src/core/lock/lock-manager.ts:82

renewalService

get renewalService(): LockRenewalService
Retrieves the renewal service implementation.

Returns LockRenewalService
the lease renewal service.
- Defined in src/core/lock/lock-manager.ts:73

Methods

create

create(): Promise<Lock>
Creates a new lease. This lease is not acquired until the acquire method is called.

Returns Promise<Lock>
a new lease instance.
- Defined in src/core/lock/lock-manager.ts:55