Nebula
Loading...
Searching...
No Matches
Public Member Functions | Private Member Functions | Private Attributes | List of all members
Messaging::MessageReader Class Reference

#include <messagereader.h>

Detailed Description

Implements a binary stream protocol for decoding messages from a stream.

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

Inherits IO::StreamReader.

Public Member Functions

 MessageReader ()
 constructor
 
virtual void SetStream (const Ptr< IO::Stream > &s)
 set stream to read from
 
Message * ReadMessage ()
 decode a new message from the stream
 
- Public Member Functions inherited from IO::StreamReader
 StreamReader ()
 constructor
 
virtual ~StreamReader ()
 destructor
 
void SetStream (const Ptr< Stream > &s)
 set stream to read from
 
const Ptr< Stream > & GetStream () const
 get currently set stream
 
bool HasStream () const
 return true if a stream is set
 
bool Eof () const
 return true if the stream has reached EOF
 
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 (MessageReader)
 

Private Attributes

Ptr< IO::BinaryReader > binaryReader
 

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::StreamReader
Ptr< Stream > stream
 
bool isOpen
 
bool streamWasOpen
 

Constructor & Destructor Documentation

◆ MessageReader()

Messaging::MessageReader::MessageReader ( )

constructor

Member Function Documentation

◆ __DeclareClass()

Messaging::MessageReader::__DeclareClass ( MessageReader )
private

◆ ReadMessage()

Message * Messaging::MessageReader::ReadMessage ( )

decode a new message from the stream

This constructs a new message from the stream.

First the FourCC class id of the message will be read, and a new message object constructed from it, then the message object will be asked to initialize itself from the stream.

◆ SetStream()

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

set stream to read from

Member Data Documentation

◆ binaryReader

Ptr<IO::BinaryReader> Messaging::MessageReader::binaryReader
private
The documentation for this class was generated from the following files: