Jolyon Hill / mbed-dev

Changes to support running on smaller memory LPC device LPC1764

Fork of mbed-dev by mbed official

Embed: (wiki syntax)

« Back to documentation index

Stream Class Reference
Protected Member Functions

Stream Class Reference

File stream. More...

#include <Stream.h>

Inherits mbed::FileLike.

Inherited by Serial.

Protected Member Functions

virtual int close ()
 Close the file.
virtual ssize_t write (const void *buffer, size_t length)
 Write the contents of a buffer to the file.
virtual ssize_t read (void *buffer, size_t length)
 Function read Reads the contents of the file into a buffer.
virtual off_t lseek (off_t offset, int whence)
 Move the file position to a given offset from a given location.
virtual int isatty ()
 Check if the handle is for a interactive terminal device.
virtual int fsync ()
 Flush any buffers associated with the FileHandle, ensuring it is up to date on disk.
virtual void lock ()
 Acquire exclusive access to this object.
virtual void unlock ()
 Release exclusive access to this object.

Detailed Description

File stream.

Synchronization level: Set by subclass

Definition at line 33 of file Stream.h.

Member Function Documentation

int close (  ) [protected, virtual]

Close the file.

Returns:
Zero on success, -1 on error.

Implements FileHandle.

Definition at line 63 of file Stream.cpp.

int fsync (  ) [protected, 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

Implements FileHandle.

Definition at line 105 of file Stream.cpp.

int isatty (  ) [protected, 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

Implements FileHandle.

Definition at line 101 of file Stream.cpp.

virtual void lock ( void   ) [protected, virtual, inherited]

Acquire exclusive access to this object.

Reimplemented in Serial.

Definition at line 127 of file FileHandle.h.

off_t lseek ( off_t  offset,
int  whence 
) [protected, 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

Implements FileHandle.

Definition at line 97 of file Stream.cpp.

ssize_t read ( void *  buffer,
size_t  length 
) [protected, 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.

Implements FileHandle.

Definition at line 82 of file Stream.cpp.

virtual void unlock ( void   ) [protected, virtual, inherited]

Release exclusive access to this object.

Reimplemented in Serial.

Definition at line 133 of file FileHandle.h.

ssize_t write ( const void *  buffer,
size_t  length 
) [protected, 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.

Implements FileHandle.

Definition at line 67 of file Stream.cpp.

Generated on Tue Jul 12 2022 15:57:29 by  doxygen 1.7.2