Messaging::BatchMessage Class Reference
#include <batchmessage.h>
Inheritance diagram for Messaging::BatchMessage:
Detailed Description
A batch of messages which is itself a message. Use batch messaging if you want to reduce thread synchronization when sending many messages through an AsyncPort. Instead batch many messages into a single batch message (which doesn't require thread synchronization), then send the batch message as one into the AsyncPort.Note that the following features don't work on batched messages:
- waiting for the message to become handled
- cancelling the message
(C) 2009 Radon Labs GmbH
Public Member Functions | |
| BatchMessage () | |
| constructor | |
| void | AddMessage (const Ptr< Message > &msg) |
| add a message | |
| const Util::Array< Ptr< Message > > & | GetMessages () const |
| read access to message array | |
| bool | CheckId (const Messaging::Id &id) const |
| return true if message is of the given id | |
| virtual void | Encode (const Ptr< IO::BinaryWriter > &writer) |
| encode message into a stream | |
| virtual void | Decode (const Ptr< IO::BinaryReader > &reader) |
| decode message from a stream | |
| void | SetHandled (bool b) |
| set the handled flag | |
| bool | Handled () const |
| return true if the message has been handled | |
| void | SetDeferred (bool b) |
| set deferred flag | |
| bool | IsDeferred () const |
| get deferred flag | |
| void | SetDeferredHandled (bool b) |
| set the deferred handled flag | |
| bool | DeferredHandled () const |
| get the deferred handled flag | |
| 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 | |
Static Public Member Functions | |
| static void | DumpRefCountingLeaks () |
| dump refcounting leaks, call at end of application (NEBULA3_DEBUG builds only!) | |
Member Function Documentation
| int Core::RefCounted::GetRefCount | ( | ) | const [inline, inherited] |
get the current refcount
Return the current refcount of the object.
| void Core::RefCounted::AddRef | ( | ) | [inline, inherited] |
increment refcount by one
Increment the refcount of the object.
| void Core::RefCounted::Release | ( | ) | [inline, inherited] |
decrement refcount and destroy object if refcount is zero
Decrement the refcount and destroy object if refcount is zero.
| const Util::String & Core::RefCounted::GetClassName | ( | ) | const [inline, inherited] |
get the class name
Get the class name of the object.
| Util::FourCC Core::RefCounted::GetClassFourCC | ( | ) | const [inline, inherited] |
get the class FourCC code
Get the class FourCC of the object.
| void Core::RefCounted::DumpRefCountingLeaks | ( | ) | [static, inherited] |
dump refcounting leaks, call at end of application (NEBULA3_DEBUG builds only!)
This method should be called as the very last before an application exits.