Euclid::FilePool::FileWriteAccessor< TFD > Class Template Reference

#include <FileAccessor.h>

Inheritance diagram for Euclid::FilePool::FileWriteAccessor< TFD >:

Collaboration diagram for Euclid::FilePool::FileWriteAccessor< TFD >:

Public Types
typedef FileAccessor< TFD >	Base_
using	ReleaseDescriptorCallback = typename Base_::ReleaseDescriptorCallback
using	SharedLock = typename Base_::SharedLock
using	UniqueLock = typename Base_::UniqueLock
Public Types inherited from Euclid::FilePool::FileAccessor< TFD >
using	ReleaseDescriptorCallback = std::function< void(TFD &&)>
Public Types inherited from Euclid::FilePool::FileAccessorBase
using	SharedMutex = boost::shared_mutex
using	SharedLock = boost::shared_lock< SharedMutex >
using	UniqueLock = boost::unique_lock< SharedMutex >
using	UpgradeLock = boost::upgrade_lock< SharedMutex >
using	UpgradeToUniqueLock = boost::upgrade_to_unique_lock< SharedMutex >

Public Member Functions
	FileWriteAccessor (TFD &&fd, ReleaseDescriptorCallback release_callback, UniqueLock lock)
virtual	~FileWriteAccessor ()
	Destructor. More...
bool	isReadOnly () const final
Public Member Functions inherited from Euclid::FilePool::FileAccessor< TFD >
virtual	~FileAccessor ()=default
	Destructor. More...
Public Member Functions inherited from Euclid::FilePool::FileAccessorBase
virtual	~FileAccessorBase ()=default

Private Attributes
UniqueLock	m_unique_lock

Additional Inherited Members
Public Attributes inherited from Euclid::FilePool::FileAccessor< TFD >
TFD	m_fd
	The wrapped file descriptor. More...
Protected Member Functions inherited from Euclid::FilePool::FileAccessor< TFD >
	FileAccessor (TFD &&fd, ReleaseDescriptorCallback release_callback)
Protected Attributes inherited from Euclid::FilePool::FileAccessor< TFD >
ReleaseDescriptorCallback	m_release_callback

Detailed Description

template<typename TFD>
class Euclid::FilePool::FileWriteAccessor< TFD >

Wraps a file descriptor together with an exclusive lock, so there can only be one accessor (no simultaneous reads!)

Template Parameters

TFD	File descriptor type

Definition at line 121 of file FileAccessor.h.

Member Typedef Documentation

template<typename TFD >

typedef FileAccessor<TFD> Euclid::FilePool::FileWriteAccessor< TFD >::Base_

Definition at line 123 of file FileAccessor.h.

template<typename TFD >

using Euclid::FilePool::FileWriteAccessor< TFD >::ReleaseDescriptorCallback = typename Base_::ReleaseDescriptorCallback

Definition at line 124 of file FileAccessor.h.

template<typename TFD >

using Euclid::FilePool::FileWriteAccessor< TFD >::SharedLock = typename Base_::SharedLock

Definition at line 125 of file FileAccessor.h.

template<typename TFD >

using Euclid::FilePool::FileWriteAccessor< TFD >::UniqueLock = typename Base_::UniqueLock

Definition at line 126 of file FileAccessor.h.

Constructor & Destructor Documentation

template<typename TFD >

Euclid::FilePool::FileWriteAccessor< TFD >::FileWriteAccessor	(	TFD &&	fd,
		ReleaseDescriptorCallback	release_callback,
		UniqueLock	lock
	)

Constructor

Parameters

fd	File descriptor
release_callback	Callback to be called at destruction
lock	Unique lock to the underlying file

template<typename TFD >

virtual Euclid::FilePool::FileWriteAccessor< TFD >::~FileWriteAccessor ( )

virtual

Destructor.

Member Function Documentation

template<typename TFD >

bool Euclid::FilePool::FileWriteAccessor< TFD >::isReadOnly ( ) const

finalvirtual

Returns

Always true

Implements Euclid::FilePool::FileAccessorBase.

Member Data Documentation

template<typename TFD >

UniqueLock Euclid::FilePool::FileWriteAccessor< TFD >::m_unique_lock

private

Definition at line 146 of file FileAccessor.h.

---

The documentation for this class was generated from the following file:

• FilePool/FilePool/FileAccessor.h