IO::IoInterfaceHandler Class Reference
#include <iointerfacehandler.h>
Inheritance diagram for IO::IoInterfaceHandler:
Detailed Description
Handler class for io interfaces.(C) 2006 Radon Labs GmbH
Public Member Functions | |
| IoInterfaceHandler () | |
| constructor | |
| virtual | ~IoInterfaceHandler () |
| destructor | |
| virtual void | Open () |
| open the handler | |
| virtual void | Close () |
| close the handler | |
| virtual bool | HandleMessage (const Ptr< Messaging::Message > &msg) |
| handle a message, return true if handled | |
| void | SetCompanyName (const Util::StringAtom &companyName) |
| set the company name | |
| const Util::StringAtom & | GetCompanyName () const |
| get the company name | |
| void | SetAppName (const Util::StringAtom &appName) |
| set the application name | |
| const Util::StringAtom & | GetAppName () const |
| get the application name | |
| virtual void | DoWork () |
| optional "per-frame" DoWork method for continuous handlers | |
| bool | IsOpen () const |
| return true if open | |
| 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!) | |
Protected Member Functions | |
| void | OnCreateDirectory (const Ptr< IO::CreateDirectory > &msg) |
| handle CreateDirectory message | |
| void | OnDeleteDirectory (const Ptr< IO::DeleteDirectory > &msg) |
| handle DeleteDirectory message | |
| void | OnDeleteFile (const Ptr< IO::DeleteFile > &msg) |
| handle DeleteFile message | |
| void | OnWriteStream (const Ptr< IO::WriteStream > &msg) |
| handle WriteStream message | |
| void | OnReadStream (const Ptr< IO::ReadStream > &msg) |
| handle ReadStream message | |
| void | OnCopyFile (const Ptr< IO::CopyFile > &msg) |
| handle CopyFile message | |
| void | OnMountArchive (const Ptr< IO::MountArchive > &msg) |
| handle MountArchive message | |
Member Function Documentation
| void IO::IoInterfaceHandler::Open | ( | ) | [virtual] |
open the handler
Opens the Interface message handler which does all the interesting stuff. This method already runs in the handler thread. The method initializes a minimal thread local Nebula3 runtime, just enough to handle the IO messages.
Reimplemented from Messaging::Handler.
| void IO::IoInterfaceHandler::Close | ( | ) | [virtual] |
close the handler
Closes the Interface message handler. This will shut down the minimal Nebula3 runtime, the method runs in the handler thread and is called just before the thread shuts down.
Reimplemented from Messaging::Handler.
| bool IO::IoInterfaceHandler::HandleMessage | ( | const Ptr< Messaging::Message > & | msg | ) | [virtual] |
handle a message, return true if handled
Handles incoming messages. This method runs in the handler thread.
Reimplemented from Messaging::Handler.
| 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.