Interface::ReadStream Class Reference
#include <readstream.h>
Detailed Description
IOInterface message to asynchronously read a stream. Note that the caller must provide a mappable stream which consumes the read content.(C) 2006 Radon Labs GmbH
Public Member Functions | |
| void | SetStream (const Ptr< IO::Stream > &stream) |
| set a stream which consumes the result of the read operation | |
| const Ptr< IO::Stream > & | GetStream () const |
| get stream with read result (after message has been handled!) | |
| void | Encode (const Ptr< IO::BinaryWriter > &writer) |
| encode message into a stream | |
| void | Decode (const Ptr< IO::BinaryReader > &reader) |
| decode message from a stream | |
| void | SetURI (const IO::URI &uri) |
| in: set URI of new directory | |
| const IO::URI & | GetURI () const |
| in: get URI of new directory | |
| void | SetResult (bool b) |
| set result of operation (true is success) | |
| bool | GetResult () const |
| get result of operation | |
| 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 | |
| bool | CheckId (const Messaging::Id &id) const |
| return true if message is of the given id | |
| void | SetHandled (bool b) |
| set the handled flag | |
| bool | Handled () const |
| return true if the message has been handled | |
| 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
| void Interface::ReadStream::SetStream | ( | const Ptr< IO::Stream > & | s | ) | [inline] |
set a stream which consumes the result of the read operation
Set the caller-provided stream which will be filled with the read data. Note that the contents of the stream will only be valid after the message has been handled by IOInterface.
| const Ptr< IO::Stream > & Interface::ReadStream::GetStream | ( | ) | const [inline] |
get stream with read result (after message has been handled!)
Get the stream which will contain the read data (after the message has been handled).
| 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.