#include <SDException.h>

Inheritance diagram for seismicdrive::error::dataset::Locked:

Collaboration diagram for seismicdrive::error::dataset::Locked:

Classes
class	Impl

Public Member Functions
std::string	getPath ()

bool	isReadLocked () const

bool	isWriteLocked () const

bool	lockFailed () const

bool	unlockFailed () const

std::uint32_t	getEstimatedLockLeaseSeconds () const

Reason const &	reason () const =delete

std::uint32_t	get_estimated_lock_lease_seconds () const =delete

	Locked (const Impl &impl)

	~Locked ()

Protected Member Functions
	Locked (Impl *impl)

Protected Attributes
std::shared_ptr< Impl >	impl

Detailed Description

API calls mutating a dataset failed to obtain a lock.

The caller must decide whether it's appropriate to retry.

Different reasons for error will warrant a different callback

Constructor & Destructor Documentation

◆ Locked() [1/2]

seismicdrive::error::dataset::Locked::Locked ( const Impl & impl )

◆ ~Locked()

seismicdrive::error::dataset::Locked::~Locked ( )

◆ Locked() [2/2]

seismicdrive::error::dataset::Locked::Locked ( Impl * impl )

protected

Member Function Documentation

◆ get_estimated_lock_lease_seconds()

std::uint32_t seismicdrive::error::dataset::Locked::get_estimated_lock_lease_seconds ( ) const

delete

◆ getEstimatedLockLeaseSeconds()

std::uint32_t seismicdrive::error::dataset::Locked::getEstimatedLockLeaseSeconds ( ) const

◆ getPath()

std::string seismicdrive::error::dataset::Locked::getPath ( )

Returns the dataset path.

◆ isReadLocked()

bool seismicdrive::error::dataset::Locked::isReadLocked ( ) const

The dataset is already read locked.

◆ isWriteLocked()

bool seismicdrive::error::dataset::Locked::isWriteLocked ( ) const

The dataset is already write locked.

◆ lockFailed()

bool seismicdrive::error::dataset::Locked::lockFailed ( ) const

Unable to lock the dataset (failed to acquire lock cache mutex).

◆ reason()

Reason const& seismicdrive::error::dataset::Locked::reason ( ) const

delete

◆ unlockFailed()

bool seismicdrive::error::dataset::Locked::unlockFailed ( ) const

Unable to unlock the dataset (failed to release lock cache mutex).

Member Data Documentation

◆ impl

std::shared_ptr<Impl> seismicdrive::error::dataset::Locked::impl