os::posix::device Class Reference

Base device class. More...

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

Inheritance diagram for os::posix::device:

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
	device (device_impl &impl, type t, const char *name)
virtual	~device () override
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)

Public Member Functions
int	open (const char *path=nullptr, int oflag=0,...)
int	vopen (const char *path, int oflag, std::va_list args)
virtual int	close (void) override
int	ioctl (int request,...)
virtual int	vioctl (int request, std::va_list args)
virtual void	sync (void)
virtual bool	match_name (const char *name) const
const char *	name (void) const
device_impl &	impl (void) const
static const char *	device_prefix (void)

Detailed Description

Base device class.

Definition at line 77 of file device.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

device()

os::posix::device::device	(	device_impl &	impl,
		type	t,
		const char *	name
	)

Definition at line 51 of file device.cpp.

~device()

os::posix::device::~device ( )

overridevirtual

Definition at line 61 of file device.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::device::close ( void  )

overridevirtual

Reimplemented from os::posix::io.

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

Definition at line 125 of file device.cpp.

device_prefix()

const char * os::posix::device::device_prefix ( void  )

inlinestatic

Definition at line 322 of file device.h.

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.

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.

get_type()

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

inlineinherited

Definition at line 423 of file io.h.

impl()

device_impl & os::posix::device::impl ( void  ) const

inline

Definition at line 316 of file device.h.

ioctl()

int os::posix::device::ioctl	(	int	request,
			...
	)

Definition at line 149 of file device.cpp.

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.

match_name()

bool os::posix::device::match_name ( const char *  name ) const

virtual

Definition at line 197 of file device.cpp.

name()

const char * os::posix::device::name ( void  ) const

inline

Definition at line 310 of file device.h.

open()

int os::posix::device::open	(	const char *	path = nullptr,
		int	oflag = 0,
			...
	)

Parameters

path	May be nullptr.
oflag	Output flags

Returns

non-negative file descriptor, -1 on failure

Definition at line 75 of file device.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.

sync()

void os::posix::device::sync ( void  )

virtual

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

Definition at line 179 of file device.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.

vioctl()

int os::posix::device::vioctl ( int  request, std::va_list  args  )

virtual

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

Definition at line 161 of file device.cpp.

vopen()

int os::posix::device::vopen	(	const char *	path,
		int	oflag,
		std::va_list	args
	)

Parameters

path	May be nullptr.
oflag	Output flags
args	Arguments

Returns

non-negative file descriptor, -1 on failure

Definition at line 87 of file device.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:

• device.h
• device.cpp