This is the final version of Mini Gateway for Automation and Security desgined for Renesas GR Peach Design Contest

Dependencies:   GR-PEACH_video GraphicsFramework HTTPServer R_BSP mbed-rpc mbed-rtos Socket lwip-eth lwip-sys lwip FATFileSystem

Fork of mbed-os-example-mbed5-blinky by mbed-os-examples

Embed: (wiki syntax)

« Back to documentation index

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.

Protected Member Functions

virtual void lock ()
 Acquire exclusive access to this object.
virtual void unlock ()
 Release exclusive access to this object.

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.

Synchronization level: Set by subclass

Definition at line 46 of file FileHandle.h.


Member Function Documentation

virtual ssize_t 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 Stream.