IO::StreamWriter Class Reference

#include <streamwriter.h>

Detailed Description

Stream writer classes provide a specialized write-interface for a stream.

This is the abstract base class for all stream writers. It is possible to attach any number of readers and writers to the same stream.

Copyright

(C) 2006 Radon Labs GmbH (C) 2013-2020 Individual contributors, see AUTHORS file

Inherits Core::RefCounted.

Inherited by Http::HtmlPageWriter, Http::HttpRequestWriter, Http::HttpResponseWriter, Http::SvgPageWriter, IO::BinaryWriter, IO::JsonWriter, IO::TextWriter, IO::XmlWriter, and Messaging::MessageWriter.

Public Member Functions
	StreamWriter ()
	constructor
virtual	~StreamWriter ()
	destructor
void	SetStream (const Ptr< Stream > &s)
	set stream to write to
const Ptr< Stream > &	GetStream () const
	get currently set stream
bool	HasStream () const
	return true if a stream is set
virtual bool	Open ()
	begin reading from the stream
virtual void	Close ()
	end reading from the stream
bool	IsOpen () const
	return true if currently open
Public Member Functions inherited from Core::RefCounted
	RefCounted ()
	constructor
int	GetRefCount () const
	get the current refcount
void	AddRef ()
	increment refcount by one
void	Release ()
	decrement refcount and destroy object if refcount is zero
bool	IsInstanceOf (const Rtti &rtti) const
	return true if this object is instance of given class
bool	IsInstanceOf (const Util::String &className) const
	return true if this object is instance of given class by string
bool	IsInstanceOf (const Util::FourCC &classFourCC) const
	return true if this object is instance of given class by fourcc
bool	IsA (const Rtti &rtti) const
	return true if this object is instance of given class, or a derived class
bool	IsA (const Util::String &rttiName) const
	return true if this object is instance of given class, or a derived class, by string
bool	IsA (const Util::FourCC &rttiFourCC) const
	return true if this object is instance of given class, or a derived class, by fourcc
const Util::String &	GetClassName () const
	get the class name
Util::FourCC	GetClassFourCC () const
	get the class FourCC code

Protected Attributes
Ptr< Stream >	stream
bool	isOpen
bool	streamWasOpen

Private Member Functions
	__DeclareClass (StreamWriter)

Additional Inherited Members
Static Public Member Functions inherited from Core::RefCounted
static void	DumpRefCountingLeaks ()
	dump refcounting leaks, call at end of application (NEBULA_DEBUG builds only!)
Protected Member Functions inherited from Core::RefCounted
virtual	~RefCounted ()
	destructor (called when refcount reaches zero)

Constructor & Destructor Documentation

StreamWriter()

IO::StreamWriter::StreamWriter

(

)

constructor

~StreamWriter()

IO::StreamWriter::~StreamWriter ( )

virtual

destructor

Member Function Documentation

__DeclareClass()

IO::StreamWriter::__DeclareClass ( StreamWriter )

private

Close()

void IO::StreamWriter::Close ( )

virtual

end reading from the stream

Reimplemented in Http::HtmlPageWriter, Http::SvgPageWriter, IO::BinaryWriter, IO::JsonWriter, and IO::XmlWriter.

GetStream()

const Ptr< Stream > & IO::StreamWriter::GetStream

(

)

const

get currently set stream

Get pointer to the attached stream.

If there is no stream attached, an assertion will be thrown. Use HasStream() to determine if a stream is attached.

HasStream()

bool IO::StreamWriter::HasStream

(

)

const

return true if a stream is set

Returns true if a stream is attached to the writer.

IsOpen()

bool IO::StreamWriter::IsOpen ( ) const

inline

return true if currently open

Open()

bool IO::StreamWriter::Open ( )

virtual

begin reading from the stream

Reimplemented in Http::HtmlPageWriter, Http::SvgLineChartWriter, Http::SvgPageWriter, IO::BinaryWriter, IO::JsonWriter, and IO::XmlWriter.

SetStream()

void IO::StreamWriter::SetStream

(

const Ptr< Stream > &

s

)

set stream to write to

Attaches the writer to a stream.

This will imcrement the refcount of the stream.

Member Data Documentation

isOpen

bool IO::StreamWriter::isOpen

protected

stream

Ptr<Stream> IO::StreamWriter::stream

protected

streamWasOpen

bool IO::StreamWriter::streamWasOpen

protected

---

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

• /github/workspace/code/foundation/io/streamwriter.h
• /github/workspace/code/foundation/io/streamwriter.cc