IO::IoInterfaceHandler Class Reference

#include <iointerfacehandler.h>

Detailed Description

Handler class for io interfaces.

Copyright

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

Inherits Interface::InterfaceHandlerBase.

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
Public Member Functions inherited from Interface::InterfaceHandlerBase
	InterfaceHandlerBase ()
	constructor
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
Public Member Functions inherited from Messaging::Handler
	Handler ()
	constructor
virtual	~Handler ()
	destructor
bool	IsOpen () const
	return true if 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

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
Protected Member Functions inherited from Core::RefCounted
virtual	~RefCounted ()
	destructor (called when refcount reaches zero)

Protected Attributes
Ptr< IO::IoServer >	ioServer
Protected Attributes inherited from Interface::InterfaceHandlerBase
Util::StringAtom	companyName
Util::StringAtom	appName
Protected Attributes inherited from Messaging::Handler
bool	isOpen

Private Member Functions
	__DeclareClass (IoInterfaceHandler)

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!)

Constructor & Destructor Documentation

IoInterfaceHandler()

IO::IoInterfaceHandler::IoInterfaceHandler

(

)

constructor

~IoInterfaceHandler()

IO::IoInterfaceHandler::~IoInterfaceHandler ( )

virtual

destructor

Member Function Documentation

__DeclareClass()

IO::IoInterfaceHandler::__DeclareClass ( IoInterfaceHandler )

private

Close()

void IO::IoInterfaceHandler::Close ( )

virtual

close the handler

Closes the Interface message handler.

This will shut down the minimal Nebula runtime, the method runs in the handler thread and is called just before the thread shuts down.

Reimplemented from Messaging::Handler.

HandleMessage()

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.

OnCopyFile()

void IO::IoInterfaceHandler::OnCopyFile ( const Ptr< IO::CopyFile > & msg )

protected

handle CopyFile message

OnCreateDirectory()

void IO::IoInterfaceHandler::OnCreateDirectory ( const Ptr< IO::CreateDirectory > & msg )

protected

handle CreateDirectory message

OnDeleteDirectory()

void IO::IoInterfaceHandler::OnDeleteDirectory ( const Ptr< IO::DeleteDirectory > & msg )

protected

handle DeleteDirectory message

OnDeleteFile()

void IO::IoInterfaceHandler::OnDeleteFile ( const Ptr< IO::DeleteFile > & msg )

protected

handle DeleteFile message

OnMountArchive()

void IO::IoInterfaceHandler::OnMountArchive ( const Ptr< IO::MountArchive > & msg )

protected

handle MountArchive message

OnReadStream()

void IO::IoInterfaceHandler::OnReadStream ( const Ptr< IO::ReadStream > & msg )

protected

handle ReadStream message

Todo

handle non-mappable stream!

OnWriteStream()

void IO::IoInterfaceHandler::OnWriteStream ( const Ptr< IO::WriteStream > & msg )

protected

handle WriteStream message

Todo

handle non-mappable stream

Open()

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 Nebula runtime, just enough to handle the IO messages.

Reimplemented from Messaging::Handler.

Member Data Documentation

ioServer

Ptr<IO::IoServer> IO::IoInterfaceHandler::ioServer

protected

---

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

• /github/workspace/code/foundation/io/iointerfacehandler.h
• /github/workspace/code/foundation/io/iointerfacehandler.cc