Marco Zecchini / Mbed OS Example_RTOS

Rtos API example

Embed: (wiki syntax)

« Back to documentation index

Stream Class Reference
Public Member Functions | Protected Member Functions | Private Member Functions

Stream Class Reference
[Stream class]

File stream. More...

#include <Stream.h>

Inherits mbed::FileLike, and NonCopyable< Stream >.

Inherited by Serial.

Public Member Functions

 MBED_DEPRECATED_SINCE ("mbed-os-5.4","Replaced by FileHandle::seek") virtual off_t lseek(off_t offset
 Move the file position to a given offset from a given location.

Protected Member Functions

virtual int close ()
 Close a file.
virtual ssize_t write (const void *buffer, size_t length)
 Write the contents of a buffer to a file.
virtual ssize_t read (void *buffer, size_t length)
 Read the contents of a file into a buffer.
virtual off_t seek (off_t offset, int whence)
 Move the file position to a given offset from from a given location.
virtual off_t tell ()
 Get the file position of the file.
virtual void rewind ()
 Rewind the file position to the beginning of the file.
virtual int isatty ()
 Check if the file in an interactive terminal device.
virtual int sync ()
 Flush any buffers associated with the file.
virtual off_t size ()
 Get the size of the file.
virtual void lock ()
 Acquire exclusive access to this object.
virtual void unlock ()
 Release exclusive access to this object.
 MBED_DEPRECATED ("Invalid copy construction of a NonCopyable resource.") NonCopyable(const NonCopyable &)
 NonCopyable copy constructor.
 MBED_DEPRECATED ("Invalid copy assignment of a NonCopyable resource.") NonCopyable &operator
 NonCopyable copy assignment operator.

Private Member Functions

 MBED_DEPRECATED ("Invalid copy construction of a NonCopyable resource.") NonCopyable(const NonCopyable &)
 NonCopyable copy constructor.
 MBED_DEPRECATED ("Invalid copy assignment of a NonCopyable resource.") NonCopyable &operator
 NonCopyable copy assignment operator.

Detailed Description

File stream.

Note:
Synchronization level: Set by subclass

Definition at line 42 of file Stream.h.

Member Function Documentation

int close (  ) [protected, virtual]

Close a file.

Returns:
0 on success, negative error code on failure

Implements FileHandle.

Definition at line 70 of file Stream.cpp.

int isatty (  ) [protected, virtual]

Check if the file in an interactive terminal device.

Returns:
True if the file is a terminal
False if the file is not a terminal
Negative error code on failure

Reimplemented from FileHandle.

Definition at line 115 of file Stream.cpp.

virtual void lock ( void   ) [protected, virtual]

Acquire exclusive access to this object.

Reimplemented in Serial.

Definition at line 77 of file Stream.h.

MBED_DEPRECATED ( "Invalid copy construction of a NonCopyable< FileBase > resource."   ) const [protected, inherited]

NonCopyable copy constructor.

A compile time warning is issued when this function is used and a runtime warning is printed when the copy construction of the non copyable happens.

If you see this warning, your code is probably doing something unspecified. Copy of non copyable resources can lead to resource leak and random error.

Definition at line 171 of file NonCopyable.h.

MBED_DEPRECATED ( "Invalid copy assignment of a NonCopyable< FileBase > resource."   ) [protected, inherited]

NonCopyable copy assignment operator.

A compile time warning is issued when this function is used and a runtime warning is printed when the copy construction of the non copyable happens.

If you see this warning, your code is probably doing something unspecified. Copy of non copyable resources can lead to resource leak and random error.

MBED_DEPRECATED_SINCE ( "mbed-os-5.4"  ,
"Replaced by FileHandle::seek"   
) [inherited]

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
ssize_t read ( void *  buffer,
size_t  size 
) [protected, virtual]

Read the contents of a file into a buffer.

Devices acting as FileHandles should follow POSIX semantics:

* if no data is available, and non-blocking set return -EAGAIN * if no data is available, and blocking set, wait until data is available * If any data is available, call returns immediately

Parameters:
bufferThe buffer to read in to
sizeThe number of bytes to read
Returns:
The number of bytes read, 0 at end of file, negative error on failure

Implements FileHandle.

Definition at line 89 of file Stream.cpp.

void rewind (  ) [protected, virtual]

Rewind the file position to the beginning of the file.

Note:
This is equivalent to seek(0, SEEK_SET)

Reimplemented from FileHandle.

Definition at line 112 of file Stream.cpp.

off_t seek ( off_t  offset,
int  whence 
) [protected, virtual]

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

Parameters:
offsetThe offset from whence to move to
whenceThe start of where to seek SEEK_SET to start from beginning of file, SEEK_CUR to start from current position in file, SEEK_END to start from end of file
Returns:
The new offset of the file, negative error code on failure

Implements FileHandle.

Definition at line 104 of file Stream.cpp.

off_t size (  ) [protected, virtual]

Get the size of the file.

Returns:
Size of the file in bytes

Reimplemented from FileHandle.

Definition at line 123 of file Stream.cpp.

int sync (  ) [protected, virtual]

Flush any buffers associated with the file.

Returns:
0 on success, negative error code on failure

Reimplemented from FileHandle.

Definition at line 119 of file Stream.cpp.

off_t tell (  ) [protected, virtual]

Get the file position of the file.

Note:
This is equivalent to seek(0, SEEK_CUR)
Returns:
The current offset in the file, negative error code on failure

Reimplemented from FileHandle.

Definition at line 108 of file Stream.cpp.

virtual void unlock ( void   ) [protected, virtual]

Release exclusive access to this object.

Reimplemented in Serial.

Definition at line 83 of file Stream.h.

ssize_t write ( const void *  buffer,
size_t  size 
) [protected, virtual]

Write the contents of a buffer to a file.

Parameters:
bufferThe buffer to write from
sizeThe number of bytes to write
Returns:
The number of bytes written, negative error on failure

Implements FileHandle.

Definition at line 74 of file Stream.cpp.

Generated on Sun Jul 17 2022 08:25:44 by  doxygen 1.7.2