mbed-drivers
Public Member Functions | List of all members
mbed::FileHandle Class Referenceabstract

#include <FileHandle.h>

Inheritance diagram for mbed::FileHandle:
mbed::FileLike mbed::Stream mbed::Serial

Public Member Functions

virtual ssize_t write (const void *buffer, size_t length)=0
 
virtual int close ()=0
 
virtual ssize_t read (void *buffer, size_t length)=0
 
virtual int isatty ()=0
 
virtual off_t lseek (off_t offset, int whence)=0
 
virtual int fsync ()=0
 
virtual off_t flen ()
 

Detailed Description

An OO equivalent of the internal FILEHANDLE variable and associated sys* functions.

FileHandle is an abstract class, needing at least sys_write and sys_read to be implmented for a simple interactive device.

No one ever directly tals to/instanciates a FileHandle - it gets created by FileSystem, and wrapped up by stdio.

Member Function Documentation

virtual int mbed::FileHandle::close ( )
pure virtual

Close the file

Returns
Zero on success, -1 on error.

Implemented in mbed::Stream.

virtual int mbed::FileHandle::fsync ( )
pure virtual

Flush any buffers associated with the FileHandle, ensuring it is up to date on disk

Returns
0 on success or un-needed, -1 on error

Implemented in mbed::Stream.

virtual int mbed::FileHandle::isatty ( )
pure virtual

Check if the handle is for a interactive terminal device. If so, line buffered behaviour is used by default

Returns
1 if it is a terminal, 0 otherwise

Implemented in mbed::Stream.

virtual off_t mbed::FileHandle::lseek ( off_t  offset,
int  whence 
)
pure virtual

Move the file position to a given offset from a given location.

Parameters
offsetThe offset from whence to move to
whenceSEEK_SET for the start of the file, SEEK_CUR for the current file position, or SEEK_END for the end of the file.
Returns
new file position on success, -1 on failure or unsupported

Implemented in mbed::Stream.

virtual ssize_t mbed::FileHandle::read ( void *  buffer,
size_t  length 
)
pure virtual

Function read Reads the contents of the file into a buffer

Parameters
bufferthe buffer to read in to
lengththe number of characters to read
Returns
The number of characters read (zero at end of file) on success, -1 on error.

Implemented in mbed::Stream.

virtual ssize_t mbed::FileHandle::write ( const void *  buffer,
size_t  length 
)
pure virtual

Write the contents of a buffer to the file

Parameters
bufferthe buffer to write from
lengththe number of characters to write
Returns
The number of characters written (possibly 0) on success, -1 on error.

Implemented in mbed::Stream.


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