Messaging::MessageWriter Class Reference

#include <messagewriter.h>

Detailed Description

Implements a binary stream protocol for encoding messages into streams.

Copyright

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

Inherits IO::StreamWriter.

Public Member Functions
	MessageWriter ()
	constructor
virtual void	SetStream (const Ptr< IO::Stream > &s)
	set stream to write to
void	WriteMessage (const Ptr< Message > &msg)
	write a complete message to the stream
Public Member Functions inherited from IO::StreamWriter
	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

Private Member Functions
	__DeclareClass (MessageWriter)

Private Attributes
Ptr< IO::BinaryWriter >	binaryWriter

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)
Protected Attributes inherited from IO::StreamWriter
Ptr< Stream >	stream
bool	isOpen
bool	streamWasOpen

Constructor & Destructor Documentation

MessageWriter()

Messaging::MessageWriter::MessageWriter

(

)

constructor

Member Function Documentation

__DeclareClass()

Messaging::MessageWriter::__DeclareClass ( MessageWriter )

private

SetStream()

void Messaging::MessageWriter::SetStream ( const Ptr< IO::Stream > & s )

virtual

set stream to write to

WriteMessage()

void Messaging::MessageWriter::WriteMessage

(

const Ptr< Message > &

msg

)

write a complete message to the stream

Writes a complete message to the stream.

First the FourCC class id of the message will be written, then the message will be asked to write its own data to the stream.

Member Data Documentation

binaryWriter

Ptr<IO::BinaryWriter> Messaging::MessageWriter::binaryWriter

private

---

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

• /github/workspace/code/foundation/messaging/messagewriter.h
• /github/workspace/code/foundation/messaging/messagewriter.cc