elm::io::BufferedOutStream Class Reference

#include <elm/io/BufferedOutStream.h>

Inheritance diagram for elm::io::BufferedOutStream:

Public Member Functions
	BufferedOutStream (OutStream &output, size_t size=default_size)
virtual	~BufferedOutStream (void)
virtual int	write (const char *buffer, int size)
virtual int	flush (void)
virtual CString	lastErrorMessage (void)
Public Member Functions inherited from elm::io::OutStream
virtual	~OutStream (void)
virtual int	write (char byte)

Static Public Attributes
static const int	default_size = 4096
Static Public Attributes inherited from elm::io::OutStream
static OutStream &	null = _null

Detailed Description

This stream provides buffered action for a given output stream.

Constructor & Destructor Documentation

elm::io::BufferedOutStream::BufferedOutStream	(	OutStream &	output,
		size_t	size = default_size
	)

Build a buffer out stream.

Parameters

output	Output stream to buffer in.
size	Size of the buffeR.

elm::io::BufferedOutStream::~BufferedOutStream ( void  )

virtual

References flush().

Member Function Documentation

int elm::io::BufferedOutStream::flush ( void  )

virtual

Cause the current stream to dump its buffer to the medium.

Returns

0 for success, less than 0 for error.

Implements elm::io::OutStream.

References elm::io::OutStream::write().

Referenced by write(), and ~BufferedOutStream().

CString elm::io::BufferedOutStream::lastErrorMessage ( void  )

virtual

Return a message for the last error.

Returns

Message of the last error.

Reimplemented from elm::io::OutStream.

References elm::io::OutStream::lastErrorMessage().

int elm::io::BufferedOutStream::write ( const char *  buffer, int  size  )

virtual

This is the main method of an output stream: the given buffer is put on the stream.

Parameters

buffer	Byte buffer to write.
size	Size of the byte buffer.

Returns

Number of transferred bytes or less than 0 for an error.

Implements elm::io::OutStream.

References flush(), and elm::io::OutStream::write().

Member Data Documentation

const int elm::io::BufferedOutStream::default_size = 4096

static

---

The documentation for this class was generated from the following files:

• include/elm/io/BufferedOutStream.h
• src/io_BufferedOutStream.cpp