Fork of the official mbed C/C SDK provides the software platform and libraries to build your applications. The fork has the documentation converted to Doxygen format
Fork of mbed by
FileHandle Class Reference
An OO equivalent of the internal FILEHANDLE variable and associated _sys_* functions. More...
#include <FileHandle.h>
Inherited by FileLike, and LocalFileHandle.
Public Member Functions | |
virtual ssize_t | write (const void *buffer, size_t length)=0 |
Write the contents of a buffer to the file. | |
virtual int | close ()=0 |
Close the file. | |
virtual ssize_t | read (void *buffer, size_t length)=0 |
Function read Reads the contents of the file into a buffer. | |
virtual int | isatty ()=0 |
Check if the handle is for a interactive terminal device. | |
virtual off_t | lseek (off_t offset, int whence)=0 |
Move the file position to a given offset from a given location. | |
virtual int | fsync ()=0 |
Flush any buffers associated with the FileHandle, ensuring it is up to date on disk. |
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.
Definition at line 29 of file FileHandle.h.
Member Function Documentation
virtual int close | ( | ) | [pure virtual] |
Close the file.
- Returns:
- Zero on success, -1 on error.
virtual int 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
virtual int 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
virtual off_t lseek | ( | off_t | offset, |
int | whence | ||
) | [pure virtual] |
Move the file position to a given offset from a given location.
- Parameters:
-
offset The offset from whence to move to whence SEEK_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
virtual ssize_t read | ( | void * | buffer, |
size_t | length | ||
) | [pure virtual] |
Function read Reads the contents of the file into a buffer.
- Parameters:
-
buffer the buffer to read in to length the number of characters to read
- Returns:
- The number of characters read (zero at end of file) on success, -1 on error.
virtual ssize_t write | ( | const void * | buffer, |
size_t | length | ||
) | [pure virtual] |
Write the contents of a buffer to the file.
- Parameters:
-
buffer the buffer to write from length the number of characters to write
- Returns:
- The number of characters written (possibly 0) on success, -1 on error.
Generated on Tue Jul 12 2022 20:01:59 by 1.7.2