Base Framework
Public Member Functions | List of all members
FileDescriptorOutputStream Class Reference

Filedescriptor output stream. More...

#include <base/io/FileDescriptorOutputStream.h>

Inherits OutputStream, and FileDescriptor.

Public Member Functions

 FileDescriptorOutputStream () noexcept
 
 FileDescriptorOutputStream (const FileDescriptor &fd) noexcept
 
 FileDescriptorOutputStream (const FileDescriptorOutputStream &copy) noexcept
 
FileDescriptorOutputStreamoperator= (const FileDescriptorOutputStream &assign) noexcept
 
void close ()
 
void flush ()
 
unsigned int write (const uint8 *buffer, unsigned int size, bool nonblocking=false)
 
 ~FileDescriptorOutputStream ()
 
- Public Member Functions inherited from Stream
virtual ~Stream () noexcept(false)
 
- Public Member Functions inherited from ReferenceCountedObject
 ReferenceCountedObject () noexcept
 
 ReferenceCountedObject (const ReferenceCountedObject &copy) noexcept
 
 ReferenceCountedObject (ReferenceCountedObject &&move) noexcept
 
ReferenceCountedObjectoperator= (const ReferenceCountedObject &copy) noexcept
 
ReferenceCountedObjectoperator= (ReferenceCountedObject &&move) noexcept
 
MemorySize getNumberOfReferences_INTERNAL () const noexcept
 
virtual bool useGarbageCollector () const noexcept
 
- Public Member Functions inherited from DynamicObject
 DynamicObject () noexcept
 
bool isValidObject () const noexcept
 
virtual ~DynamicObject () noexcept(false)
 
 _COM_AZURE_DEV__BASE__OVERRIDE_ALLOC ()
 
- Public Member Functions inherited from FileDescriptor
 FileDescriptor () noexcept
 
 FileDescriptor (OperatingSystem::Handle handle) noexcept
 
 FileDescriptor (const FileDescriptor &copy) noexcept
 
FileDescriptoroperator= (const FileDescriptor &assign) noexcept
 
bool isANSITerminal () const noexcept
 
bool isTerminal () const noexcept
 
bool isPipe () const noexcept
 
int getFlags () const
 
void setFlags (int flags)
 
OperatingSystem::Handle getHandle () const noexcept
 
bool isValid () const noexcept
 
void setHandle (OperatingSystem::Handle handle) noexcept
 
void setNonBlocking (bool value)
 
 ~FileDescriptor ()
 

Additional Inherited Members

- Static Public Member Functions inherited from FileDescriptor
static FileDescriptor getStandardInput () noexcept
 
static FileDescriptor getStandardOutput () noexcept
 
static FileDescriptor getStandardError () noexcept
 
- Protected Attributes inherited from FileDescriptor
Reference< Handlefd
 

Detailed Description

Filedescriptor output stream.

The FileDescriptorOutputStream class serves as a general handle to a sink of bytes within the operatingsystem (e.g. file, socket and pipe). This class is normally not used directly by the application.

Version
1.0

Constructor & Destructor Documentation

◆ FileDescriptorOutputStream() [1/3]

FileDescriptorOutputStream::FileDescriptorOutputStream ( )
noexcept

Initializes file descriptor output stream as invalid.

◆ FileDescriptorOutputStream() [2/3]

FileDescriptorOutputStream::FileDescriptorOutputStream ( const FileDescriptor fd)
noexcept

Initializes file descriptor output stream from a file descriptor.

Parameters
fdThe file descriptor.

◆ FileDescriptorOutputStream() [3/3]

FileDescriptorOutputStream::FileDescriptorOutputStream ( const FileDescriptorOutputStream copy)
noexcept

Initializes file descriptor output stream from other file descriptor output stream.

◆ ~FileDescriptorOutputStream()

FileDescriptorOutputStream::~FileDescriptorOutputStream ( )

Releases the file descriptor.

Member Function Documentation

◆ close()

void FileDescriptorOutputStream::close ( )
inlinevirtual

Closes the stream and releases any system resources associated with the stream.

Reimplemented from FileDescriptor.

◆ flush()

void FileDescriptorOutputStream::flush ( )
virtual

Forces any buffered bytes to be written out.

Implements OutputStream.

◆ operator=()

FileDescriptorOutputStream& FileDescriptorOutputStream::operator= ( const FileDescriptorOutputStream assign)
noexcept

Assignment of file descriptor output stream to this file descriptor output stream.

◆ write()

unsigned int FileDescriptorOutputStream::write ( const uint8 *  buffer,
unsigned int  size,
bool  nonblocking = false 
)
virtual

Writes bytes in buffer to stream.

Parameters
bufferThe buffer containing the bytes to be written.
sizeThe number of bytes to be written.
Returns
The actual number of bytes written.

Implements OutputStream.