µOS++ IIIe Reference 7.0.0
The third edition of µOS++, a POSIX inspired open source framework, written in C++
Loading...
Searching...
No Matches
List of all members
os::posix::file Class Reference
µOS++ POSIX I/O C++ API » Basic classes

File class. More...

#include <cmsis-plus/posix-io/file.h>

+ Inheritance diagram for os::posix::file:

Public Types

Types & Constants
enum  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 (file_impl &impl)
 
virtual ~file () override
 
Public Member Functions
virtual int close (void) override
 
virtual int ftruncate (off_t length)
 
virtual int fsync (void)
 
virtual int fstatvfs (struct statvfs *buf)
 
class file_system & file_system (void)
 
file_impl & impl (void) const
 
Public Member Functions
virtual ssize_t read (void *buf, std::size_t nbyte)
 
virtual ssize_t write (const void *buf, std::size_t nbyte)
 
virtual ssize_t writev (const struct iovec *iov, int iovcnt)
 
int fcntl (int cmd,...)
 
virtual int vfcntl (int cmd, std::va_list args)
 
int isatty (void)
 
virtual int fstat (struct stat *buf)
 
virtual off_t lseek (off_t offset, int whence)
 
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

File class.

Definition at line 74 of file file.h.

Member Typedef Documentation

◆ type_t

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

Definition at line 132 of file io.h.

Member Enumeration Documentation

◆ type

enum os::posix::io::type : type_t
inherited
Enumerator
unknown 
not_set 
char_device 
block_device 
tty 
file 
socket 

Definition at line 133 of file io.h.

Constructor & Destructor Documentation

◆ file()

os::posix::file::file ( file_impl &  impl)

Definition at line 49 of file file.cpp.

◆ ~file()

os::posix::file::~file ( )
overridevirtual

Definition at line 58 of file file.cpp.

Member Function Documentation

◆ alloc_file_descriptor()

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

Definition at line 201 of file io.cpp.

◆ clear_file_descriptor()

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

Definition at line 435 of file io.h.

◆ close()

int os::posix::file::close ( void  )
overridevirtual

Reimplemented from os::posix::io.

Reimplemented in os::posix::file_lockable< T, L >.

Definition at line 68 of file file.cpp.

◆ fcntl()

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

Definition at line 375 of file io.cpp.

◆ file_descriptor() [1/2]

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

Definition at line 429 of file io.h.

◆ file_descriptor() [2/2]

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

Definition at line 441 of file io.h.

◆ file_system()

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

Definition at line 459 of file file.h.

◆ fstat()

int os::posix::io::fstat ( struct stat *  buf)
virtualinherited

Reimplemented in os::posix::file_lockable< T, L >.

Definition at line 422 of file io.cpp.

◆ fstatvfs()

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

Definition at line 118 of file file.cpp.

◆ fsync()

int os::posix::file::fsync ( void  )
virtual

Reimplemented in os::posix::file_lockable< T, L >.

Definition at line 105 of file file.cpp.

◆ ftruncate()

int os::posix::file::ftruncate ( off_t  length)
virtual

Reimplemented in os::posix::file_lockable< T, L >.

Definition at line 86 of file file.cpp.

◆ get_type()

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

Definition at line 423 of file io.h.

◆ impl()

file_impl & os::posix::file::impl ( void  ) const
inline

Definition at line 465 of file file.h.

◆ is_opened()

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

Definition at line 447 of file io.h.

◆ isatty()

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

Definition at line 412 of file io.cpp.

◆ lseek()

off_t os::posix::io::lseek ( off_t  offset,
int  whence 
)
virtualinherited

Reimplemented in os::posix::block_device_lockable< T, L >, and os::posix::file_lockable< T, L >.

Definition at line 453 of file io.cpp.

◆ read()

ssize_t os::posix::io::read ( void *  buf,
std::size_t  nbyte 
)
virtualinherited

Reimplemented in os::posix::block_device_lockable< T, L >, and os::posix::file_lockable< T, L >.

Definition at line 229 of file io.cpp.

◆ vfcntl()

int os::posix::io::vfcntl ( int  cmd,
std::va_list  args 
)
virtualinherited

Reimplemented in os::posix::block_device_lockable< T, L >, and os::posix::file_lockable< T, L >.

Definition at line 387 of file io.cpp.

◆ write()

ssize_t os::posix::io::write ( const void *  buf,
std::size_t  nbyte 
)
virtualinherited

Reimplemented in os::posix::block_device_lockable< T, L >, and os::posix::file_lockable< T, L >.

Definition at line 280 of file io.cpp.

◆ writev()

ssize_t os::posix::io::writev ( const struct iovec *  iov,
int  iovcnt 
)
virtualinherited

Reimplemented in os::posix::block_device_lockable< T, L >, and os::posix::file_lockable< T, L >.

Definition at line 333 of file io.cpp.

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