miosix::FileDescriptorTable Class Reference

#include <file_access.h>

Public Member Functions
	FileDescriptorTable ()
	FileDescriptorTable (const FileDescriptorTable &rhs)
FileDescriptorTable &	operator= (const FileDescriptorTable &rhs)
int	open (const char *name, int flags, int mode)
int	close (int fd)
void	closeAll ()
ssize_t	write (int fd, const void *data, size_t len)
ssize_t	read (int fd, void *data, size_t len)
off_t	lseek (int fd, off_t pos, int whence)
int	fstat (int fd, struct stat *pstat) const
int	isatty (int fd) const
int	stat (const char *name, struct stat *pstat)
int	lstat (const char *name, struct stat *pstat)
int	fcntl (int fd, int cmd, int opt)
int	ioctl (int fd, int cmd, void *arg)
int	getdents (int fd, void *dp, int len)
int	getcwd (char *buf, size_t len)
int	chdir (const char *name)
int	mkdir (const char *name, int mode)
int	rmdir (const char *name)
int	unlink (const char *name)
int	rename (const char *oldName, const char *newName)
intrusive_ref_ptr< FileBase >	getFile (int fd) const
	~FileDescriptorTable ()

Detailed Description

This class maps file descriptors to file objects, allowing to perform file operations

Constructor & Destructor Documentation

miosix::FileDescriptorTable::FileDescriptorTable

(

)

Constructor

miosix::FileDescriptorTable::FileDescriptorTable

(

const FileDescriptorTable &

rhs

)

Copy constructor

Parameters

rhs	object to copy from

miosix::FileDescriptorTable::~FileDescriptorTable

(

)

Destructor

Member Function Documentation

int miosix::FileDescriptorTable::chdir

(

const char *

name

)

Change current directory

Parameters

path	new current directory

Returns

0 on success, or a negative number on failure

int miosix::FileDescriptorTable::close

(

int

fd

)

Close a file

Parameters

fd	file descriptor to close

Returns

0 on success or a negative number on failure

void miosix::FileDescriptorTable::closeAll

(

)

Close all files

int miosix::FileDescriptorTable::fcntl ( int  fd, int  cmd, int  opt  )

inline

Perform various operations on a file descriptor

Parameters

cmd	specifies the operation to perform
opt	optional argument that some operation require

Returns

the exact return value depends on CMD, -1 is returned on error

int miosix::FileDescriptorTable::fstat ( int  fd, struct stat *  pstat  ) const

inline

Return file information.

Parameters

pstat

pointer to stat struct

Returns

0 on success, or a negative number on failure

int miosix::FileDescriptorTable::getcwd	(	char *	buf,
		size_t	len
	)

Return current directory

Parameters

buf	the current directory is stored here
len	buffer length, if it is not big enough, ERANGE is returned

Returns

0 on success, or a negative number on failure

int miosix::FileDescriptorTable::getdents ( int  fd, void *  dp, int  len  )

inline

List directory content

Parameters

dp	dp pointer to a memory buffer where one or more struct dirent will be placed. dp must be four words aligned.
len	memory buffer size.

Returns

the number of bytes read on success, or a negative number on failure.

intrusive_ref_ptr<FileBase> miosix::FileDescriptorTable::getFile ( int  fd ) const

inline

Retrieves an entry in the file descriptor table

Parameters

fd	file descriptor, index into the table

Returns

a refcounted poiter to the file at the desired entry (which may be empty), or an empty refcounted pointer if the index is out of bounds

int miosix::FileDescriptorTable::ioctl ( int  fd, int  cmd, void *  arg  )

inline

Perform various operations on a file descriptor

Parameters

cmd	specifies the operation to perform
arg	optional argument that some operation require

Returns

the exact return value depends on CMD, -1 is returned on error

int miosix::FileDescriptorTable::isatty ( int  fd ) const

inline

Check whether the file refers to a terminal.

Returns

1 if it is a terminal, 0 if it is not, or a negative number in case of errors

off_t miosix::FileDescriptorTable::lseek ( int  fd, off_t  pos, int  whence  )

inline

Move file pointer, if the file supports random-access.

Parameters

pos	offset to sum to the beginning of the file, current position or end of file, depending on whence
whence	SEEK_SET, SEEK_CUR or SEEK_END

Returns

the offset from the beginning of the file if the operation completed, or a negative number in case of errors

int miosix::FileDescriptorTable::lstat ( const char *  name, struct stat *  pstat  )

inline

Return file information, does not follow last symlink

Parameters

path	file to stat
pstat	pointer to stat struct

Returns

0 on success, or a negative number on failure

int miosix::FileDescriptorTable::mkdir	(	const char *	name,
		int	mode
	)

Create a directory

Parameters

name	directory to create
mode	directory permissions

Returns

0 on success, or a negative number on failure

int miosix::FileDescriptorTable::open	(	const char *	name,
		int	flags,
		int	mode
	)

Open a file

Parameters

name	file name
flags	file open mode
mode	allows to set file permissions

Returns

a file descriptor, or a negative number on error

FileDescriptorTable & miosix::FileDescriptorTable::operator=

(

const FileDescriptorTable &

rhs

)

Operator=

Parameters

rhs	object to copy from

Returns

*this

ssize_t miosix::FileDescriptorTable::read ( int  fd, void *  data, size_t  len  )

inline

Read data from the file, if the file supports reading.

Parameters

data	buffer to store read data
len	the number of bytes to read

Returns

the number of read characters, or a negative number in case of errors

int miosix::FileDescriptorTable::rename	(	const char *	oldName,
		const char *	newName
	)

Rename a file or directory

Parameters

oldName	old file name
newName	new file name

Returns

0 on success, or a negative number on failure

int miosix::FileDescriptorTable::rmdir

(

const char *

name

)

Remove a directory if empty

Parameters

name	directory to create

Returns

0 on success, or a negative number on failure

int miosix::FileDescriptorTable::stat ( const char *  name, struct stat *  pstat  )

inline

Return file information, follows last symlink

Parameters

path	file to stat
pstat	pointer to stat struct

Returns

0 on success, or a negative number on failure

int miosix::FileDescriptorTable::unlink

(

const char *

name

)

Remove a file or directory

Parameters

name	file or directory to remove

Returns

0 on success, or a negative number on failure

ssize_t miosix::FileDescriptorTable::write ( int  fd, const void *  data, size_t  len  )

inline

Write data to the file, if the file supports writing.

Parameters

data	the data to write
len	the number of bytes to write

Returns

the number of written characters, or a negative number in case of errors

---

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

• file_access.h
• file_access.cpp