os::posix::file_lockable< T, L > Class Template Reference

#include <file.h>

Inheritance diagram for os::posix::file_lockable< T, L >:

Public Types
using	lockable_type = L
using	value_type = T
Types & Constants
enum class	type : type_t {   unknown = 0 ,   not_set = 1 << 0 ,   char_device = 1 << 1 ,   block_device = 1 << 2 ,   tty = 1 << 3 ,   file = 1 << 4 ,   socket = 1 << 5 }
using	type_t = unsigned int

Public Member Functions
Constructors & Destructor
	file_lockable (file_system &fs, lockable_type &locker)
virtual	~file_lockable () override
Public Member Functions
virtual int	close (void) override
virtual ssize_t	read (void *buf, std::size_t nbyte) override
virtual ssize_t	write (const void *buf, std::size_t nbyte) override
virtual ssize_t	writev (const iovec *iov, int iovcnt) override
virtual int	vfcntl (int cmd, std::va_list args) override
virtual int	fstat (struct stat *buf) override
virtual off_t	lseek (off_t offset, int whence) override
virtual int	ftruncate (off_t length) override
virtual int	fsync (void) override
value_type &	impl (void) const
Public Member Functions
virtual int	fstatvfs (struct statvfs *buf)
class file_system &	get_file_system (void)
Public Member Functions
int	fcntl (int cmd,...)
int	isatty (void)
type_t	get_type (void) const
file_descriptor_t	file_descriptor (void) const
bool	is_opened (void)

Protected Member Functions
Private Member Functions
void	file_descriptor (file_descriptor_t fildes)
void	clear_file_descriptor (void)
io *	alloc_file_descriptor (void)

Detailed Description

template<typename T, typename L>
class os::posix::file_lockable< T, L >

Definition at line 354 of file file.h.

Member Typedef Documentation

lockable_type

template<typename T , typename L >

using os::posix::file_lockable< T, L >::lockable_type = L

Definition at line 360 of file file.h.

type_t

using os::posix::io::type_t = unsigned int

inherited

Definition at line 125 of file io.h.

value_type

template<typename T , typename L >

using os::posix::file_lockable< T, L >::value_type = T

Definition at line 359 of file file.h.

Member Enumeration Documentation

type

enum class os::posix::io::type : type_t

stronginherited

Enumerator
unknown
not_set
char_device
block_device
tty
file
socket

Definition at line 126 of file io.h.

      {
        unknown = 0,
        not_set = 1 << 0,
        char_device = 1 << 1,
        block_device = 1 << 2,
        tty = 1 << 3,
        file = 1 << 4,
        socket = 1 << 5
      };

Constructor & Destructor Documentation

file_lockable()

template<typename T , typename L >

os::posix::file_lockable< T, L >::file_lockable	(	file_system &	fs,
		lockable_type &	locker
	)

Definition at line 533 of file file.h.

        : file{ impl_instance_ }, //
          impl_instance_{ fs }, //
          locker_ (locker)
    {
#if defined(OS_TRACE_POSIX_IO_FILE)
      trace::printf ("file_lockable::%s()=@%p\n", __func__, this);
#endif
    }

References os::trace::printf().

~file_lockable()

template<typename T , typename L >

os::posix::file_lockable< T, L >::~file_lockable

overridevirtual

Definition at line 550 of file file.h.

    {
#if defined(OS_TRACE_POSIX_IO_FILE)
      trace::printf ("file_lockable::%s() @%p\n", __func__, this);
#endif
    }

References os::trace::printf().

Member Function Documentation

alloc_file_descriptor()

io * os::posix::io::alloc_file_descriptor ( void  )

protectedinherited

Definition at line 189 of file io.cpp.

    {
#if defined(OS_TRACE_POSIX_IO_IO)
      trace::printf ("io::%s() @%p\n", __func__, this);
#endif
 
      int fd = file_descriptors_manager::allocate (this);
      if (fd < 0)
        {
          // If allocation failed, close this object.
          impl ().do_close ();
          clear_file_descriptor ();
          return nullptr;
        }
 
#if defined(OS_TRACE_POSIX_IO_IO)
      trace::printf ("io::%s() @%p fd=%d\n", __func__, this, fd);
#endif
 
      // Return a valid pointer to an object derived from `io`.
      return this;
    }

References os::posix::file_descriptors_manager::allocate(), os::posix::io::clear_file_descriptor(), os::posix::io_impl::do_close(), os::posix::io::impl(), and os::trace::printf().

Referenced by os::posix::socket::accept(), os::posix::socket(), os::posix::device::vopen(), and os::posix::file_system::vopen().

clear_file_descriptor()

void os::posix::io::clear_file_descriptor ( void  )

inlineprotectedinherited

Definition at line 446 of file io.h.

    {
      file_descriptor_ = no_file_descriptor;
    }

References os::posix::no_file_descriptor.

Referenced by os::posix::io::alloc_file_descriptor().

close()

template<typename T , typename L >

int os::posix::file_lockable< T, L >::close ( void  )

overridevirtual

Reimplemented from os::posix::file.

Definition at line 562 of file file.h.

    {
      std::lock_guard<L> lock{ locker_ };
 
      return file::close ();
    }

References os::posix::file::close().

fcntl()

int os::posix::io::fcntl ( int  cmd,   ...  )

inherited

Definition at line 363 of file io.cpp.

    {
      // Forward to the variadic version of the function.
      std::va_list args;
      va_start (args, cmd);
      int ret = vfcntl (cmd, args);
      va_end (args);
 
      return ret;
    }

References os::posix::io::vfcntl().

file_descriptor() [1/2]

void os::posix::io::file_descriptor ( file_descriptor_t  fildes )

inlineprotectedinherited

Definition at line 440 of file io.h.

    {
      file_descriptor_ = fildes;
    }

file_descriptor() [2/2]

file_descriptor_t os::posix::io::file_descriptor ( void  ) const

inlineinherited

Definition at line 452 of file io.h.

    {
      return file_descriptor_;
    }

Referenced by os::posix::file_descriptors_manager::allocate(), os::posix::file_descriptors_manager::assign(), os::posix::device::vopen(), and os::posix::vopen().

fstat()

template<typename T , typename L >

int os::posix::file_lockable< T, L >::fstat ( struct stat *  buf )

overridevirtual

Reimplemented from os::posix::io.

Definition at line 612 of file file.h.

    {
      std::lock_guard<L> lock{ locker_ };
 
      return file::fstat (buf);
    }

References os::posix::io::fstat().

fstatvfs()

int os::posix::file::fstatvfs ( struct statvfs *  buf )

virtualinherited

Definition at line 104 of file file.cpp.

    {
#if defined(OS_TRACE_POSIX_IO_FILE)
      trace::printf ("file::%s(%p) @%p\n", __func__, buf, this);
#endif
 
      errno = 0;
 
      // Execute the file system code. Might be locked there.
      return get_file_system ().statvfs (buf);
    }

References os::posix::file::get_file_system(), os::trace::printf(), and os::posix::file_system::statvfs().

fsync()

template<typename T , typename L >

int os::posix::file_lockable< T, L >::fsync ( void  )

overridevirtual

Reimplemented from os::posix::file.

Definition at line 640 of file file.h.

    {
      std::lock_guard<L> lock{ locker_ };
 
      return file::fsync ();
    }

References os::posix::file::fsync().

ftruncate()

template<typename T , typename L >

int os::posix::file_lockable< T, L >::ftruncate ( off_t  length )

overridevirtual

Reimplemented from os::posix::file.

Definition at line 631 of file file.h.

    {
      std::lock_guard<L> lock{ locker_ };
 
      return file::ftruncate (length);
    }

References os::posix::file::ftruncate().

get_file_system()

file_system & os::posix::file::get_file_system ( void  )

inlineinherited

Definition at line 478 of file file.h.

    {
      return impl ().get_file_system ();
    }

References os::posix::file_impl::get_file_system(), and os::posix::file::impl().

Referenced by os::posix::file::close(), and os::posix::file::fstatvfs().

get_type()

io::type_t os::posix::io::get_type ( void  ) const

inlineinherited

Definition at line 434 of file io.h.

    {
      return type_;
    }

Referenced by os::posix::file_descriptors_manager::socket().

impl()

template<typename T , typename L >

file_lockable< T, L >::value_type & os::posix::file_lockable< T, L >::impl

(

void

)

const

Definition at line 649 of file file.h.

    {
      return static_cast<value_type&> (impl_);
    }

is_opened()

bool os::posix::io::is_opened ( void  )

inlineinherited

Definition at line 458 of file io.h.

    {
      return impl ().do_is_opened ();
    }

References os::posix::io_impl::do_is_opened(), and os::posix::io::impl().

isatty()

int os::posix::io::isatty ( void  )

inherited

Definition at line 406 of file io.cpp.

    {
      errno = 0;
 
      // Execute the implementation specific code.
      return impl ().do_isatty ();
    }

References os::posix::io_impl::do_isatty(), and os::posix::io::impl().

lseek()

template<typename T , typename L >

off_t os::posix::file_lockable< T, L >::lseek ( off_t  offset, int  whence  )

overridevirtual

Reimplemented from os::posix::io.

Definition at line 622 of file file.h.

    {
      std::lock_guard<L> lock{ locker_ };
 
      return file::lseek (offset, whence);
    }

References os::posix::io::lseek().

read()

template<typename T , typename L >

ssize_t os::posix::file_lockable< T, L >::read ( void *  buf, std::size_t  nbyte  )

overridevirtual

Reimplemented from os::posix::io.

Definition at line 571 of file file.h.

    {
      std::lock_guard<L> lock{ locker_ };
 
      return file::read (buf, nbyte);
    }

References os::posix::io::read().

vfcntl()

template<typename T , typename L >

int os::posix::file_lockable< T, L >::vfcntl ( int  cmd, std::va_list  args  )

overridevirtual

Reimplemented from os::posix::io.

Definition at line 598 of file file.h.

    {
      std::lock_guard<L> lock{ locker_ };
 
      return file::vfcntl (cmd, args);
    }

References os::posix::io::vfcntl().

write()

template<typename T , typename L >

ssize_t os::posix::file_lockable< T, L >::write ( const void *  buf, std::size_t  nbyte  )

overridevirtual

Reimplemented from os::posix::io.

Definition at line 580 of file file.h.

    {
      std::lock_guard<L> lock{ locker_ };
 
      return file::write (buf, nbyte);
    }

References os::posix::io::write().

writev()

template<typename T , typename L >

ssize_t os::posix::file_lockable< T, L >::writev ( const iovec *  iov, int  iovcnt  )

overridevirtual

Reimplemented from os::posix::io.

Definition at line 589 of file file.h.

    {
      std::lock_guard<L> lock{ locker_ };
 
      return file::writev (iov, iovcnt);
    }

References os::posix::io::writev().

---

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

• file.h