Strategy for mongodb-based distributed locking.
More...
#include <userver/storages/mongo/dist_lock_strategy.hpp>
|
| DistLockStrategy (Collection collection, std::string lock_name) |
| Targets a distributed lock in a specified collection as a host.
|
|
| DistLockStrategy (Collection collection, std::string lock_name, std::string owner) |
|
void | Acquire (std::chrono::milliseconds lock_ttl, const std::string &locker_id) override |
|
void | Release (const std::string &locker_id) override |
|
Strategy for mongodb-based distributed locking.
Definition at line 14 of file dist_lock_strategy.hpp.
◆ Acquire()
void storages::mongo::DistLockStrategy::Acquire |
( |
std::chrono::milliseconds |
lock_ttl, |
|
|
const std::string & |
locker_id |
|
) |
| |
|
overridevirtual |
Acquires the distributed lock.
- Parameters
-
lock_ttl | The duration for which the lock must be held. |
locker_id | Globally unique ID of the locking entity. |
- Exceptions
-
LockIsAcquiredByAnotherHostError | when the lock is busy |
anything | else when the locking fails, strategy is responsible for cleanup, Release won't be invoked. |
Implements dist_lock::DistLockStrategyBase.
◆ Release()
void storages::mongo::DistLockStrategy::Release |
( |
const std::string & |
locker_id | ) |
|
|
overridevirtual |
The documentation for this class was generated from the following file: