llfio_v2_xxx::lockable_byte_io_handle::extent_guard Class Reference

EXTENSION: RAII holder a locked extent of bytes in a file. More...

#include "lockable_byte_io_handle.hpp"

Public Member Functions
	extent_guard (const extent_guard &)=delete
extent_guard &	operator= (const extent_guard &)=delete
constexpr	extent_guard ()
	Default constructor.
	extent_guard (extent_guard &&o) noexcept
	Move constructor.
extent_guard &	operator= (extent_guard &&o) noexcept
	Move assign.
	operator bool () const noexcept
	True if extent guard is valid.
lockable_byte_io_handle *	handle () const noexcept
	The lockable_byte_io_handle to be unlocked.
void	set_handle (lockable_byte_io_handle *h) noexcept
	Sets the lockable_byte_io_handle to be unlocked.
std::tuple< extent_type, extent_type, lock_kind >	extent () const noexcept
	The extent to be unlocked.
void	unlock () noexcept
	Unlocks the locked extent immediately.
void	release () noexcept
	Detach this RAII unlocker from the locked state.

Protected Member Functions
constexpr	extent_guard (lockable_byte_io_handle *h, extent_type offset, extent_type length, lock_kind kind)

Friends
class	lockable_byte_io_handle

Detailed Description

EXTENSION: RAII holder a locked extent of bytes in a file.

Constructor & Destructor Documentation

extent_guard() [1/3]

constexpr llfio_v2_xxx::lockable_byte_io_handle::extent_guard::extent_guard ( lockable_byte_io_handle *  h, extent_type  offset, extent_type  length, lock_kind  kind  )

inlineconstexprprotected

        : _h(h)
        , _offset(offset)
        , _length(length)
        , _kind(kind)
    {
    }

extent_guard() [2/3]

constexpr llfio_v2_xxx::lockable_byte_io_handle::extent_guard::extent_guard ( )

inlineconstexpr

Default constructor.

{}  // NOLINT

extent_guard() [3/3]

llfio_v2_xxx::lockable_byte_io_handle::extent_guard::extent_guard ( extent_guard &&  o )

inlinenoexcept

Move constructor.

        : _h(o._h)
        , _offset(o._offset)
        , _length(o._length)
        , _kind(o._kind)
    {
      o.release();
    }

~extent_guard()

llfio_v2_xxx::lockable_byte_io_handle::extent_guard::~extent_guard ( )

inline

    {
      if(_h != nullptr)
      {
        unlock();
      }
    }

Member Function Documentation

extent()

std::tuple< extent_type, extent_type, lock_kind > llfio_v2_xxx::lockable_byte_io_handle::extent_guard::extent ( ) const

inlinenoexcept

The extent to be unlocked.

{ return std::make_tuple(_offset, _length, _kind); }

handle()

lockable_byte_io_handle * llfio_v2_xxx::lockable_byte_io_handle::extent_guard::handle ( ) const

inlinenoexcept

The lockable_byte_io_handle to be unlocked.

{ return _h; }

operator bool()

llfio_v2_xxx::lockable_byte_io_handle::extent_guard::operator bool ( ) const

inlineexplicitnoexcept

True if extent guard is valid.

{ return _h != nullptr; }

operator=()

extent_guard & llfio_v2_xxx::lockable_byte_io_handle::extent_guard::operator= ( extent_guard &&  o )

inlinenoexcept

Move assign.

    {
      if(this == &o)
      {
        return *this;
      }
      unlock();
      _h = o._h;
      _offset = o._offset;
      _length = o._length;
      _kind = o._kind;
      o.release();
      return *this;
    }

release()

void llfio_v2_xxx::lockable_byte_io_handle::extent_guard::release ( )

inlinenoexcept

Detach this RAII unlocker from the locked state.

    {
      _h = nullptr;
      _offset = 0;
      _length = 0;
      _kind = lock_kind::unlocked;
    }

set_handle()

void llfio_v2_xxx::lockable_byte_io_handle::extent_guard::set_handle ( lockable_byte_io_handle *  h )

inlinenoexcept

Sets the lockable_byte_io_handle to be unlocked.

{ _h = h; }

unlock()

void llfio_v2_xxx::lockable_byte_io_handle::extent_guard::unlock ( )

inlinenoexcept

Unlocks the locked extent immediately.

    {
      if(_h != nullptr)
      {
        _h->unlock_file_range(_offset, _length);
        release();
      }
    }

---

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

• include/llfio/v2.0/lockable_byte_io_handle.hpp