Yihui Xiong / nrf51822_fix_i2c_spi_conflict

fix nrf51822 i2c & spi conflict

Dependencies:   BLE_API eMPL_MPU6050 nRF51822

Fork of Seeed_Tiny_BLE_Flash by Darren Huang

Embed: (wiki syntax)

« Back to documentation index

FileHandle Class Reference
Public Member Functions

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 42 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:
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
virtual ssize_t 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.
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.
Generated on Tue Jul 12 2022 14:43:30 by  doxygen 1.7.2