dist_lock_settings.hpp

Go to the documentation of this file.

#pragma once
 
/// @file userver/dist_lock/dist_lock_settings.hpp
/// @brief @copybrief dist_lock::DistLockSettings
 
#include <chrono>
 
USERVER_NAMESPACE_BEGIN
 
/// @brief Distributed locking
namespace dist_lock {
 
/// Distributed lock settings
struct DistLockSettings {
    /// How often to try to acquire the lock.
    std::chrono::milliseconds acquire_interval{100};
 
    /// How often to try to prolong the lock while holding the lock.
    std::chrono::milliseconds prolong_interval{100};
 
    /// For how long to acquire/prolong the lock.
    std::chrono::milliseconds lock_ttl{1000};
 
    /// How much time we allow for the worker to stop when we're unable to prolong
    /// the lock.
    std::chrono::milliseconds forced_stop_margin{50};
 
    /// Delay before failed worker_func restart
    std::chrono::milliseconds worker_func_restart_delay{100};
 
    /// Defaults to `true` and is updated from dynamic config.
    /// When switched to `false`, @ref dist_lock::DistLockedWorker will not start any new distributed lock acquisition
    /// attempts. If a `DoWork` invocation is already running under the lock, it is allowed to finish without forced
    /// cancellation. In this case @ref dist_lock::DistLockedWorker::IsCancelAdvised returns `true`.
    bool is_enabled{true};
};
 
/// Distributed lock waiting mode
enum class DistLockWaitingMode {
    kWait,    ///< waits until distlock becomes free
    kNoWait,  ///< doesn't wait for distlock if it is occupied
};
 
/// Distributed lock retry strategy
enum class DistLockRetryMode {
    kRetry,          ///< Retry on user exception/lock drop
    kSingleAttempt,  ///< Don't retry on user exception/lock drop
};
 
}  // namespace dist_lock
 
USERVER_NAMESPACE_END