Core::CoreServer Class Reference

#include <coreserver.h>

Detailed Description

The central core server object initializes a minimal Nebula runtime environment necessary to boot up the rest of Nebula.

It should be the first object a Nebula application creates, and the last to destroy before shutdown.

Copyright

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

Inherits Core::RefCounted.

Public Member Functions
	CoreServer ()
	constructor
virtual	~CoreServer ()
	destructor
void	SetCompanyName (const Util::StringAtom &s)
	set the company name
const Util::StringAtom &	GetCompanyName () const
	get the company name
void	SetAppName (const Util::StringAtom &s)
	set the application name
const Util::StringAtom &	GetAppName () const
	get the application name
void	SetRootDirectory (const Util::StringAtom &s)
	set the root directory of the application (default is "home:")
const Util::StringAtom &	GetRootDirectory () const
	get the root directory of the application
void	SetToolDirectory (const Util::StringAtom &s)
	set the tools directory ("tool:")
const Util::StringAtom &	GetToolDirectory () const
	get the tools directory
void	Open ()
	open the core server
void	Close ()
	close the core server
bool	IsOpen () const
	return true if currently open
void	Trigger ()
	trigger core server, updates console
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 (CoreServer)
	__DeclareSingleton (CoreServer)

Private Attributes
Ptr< IO::Console >	con
Util::StringAtom	companyName
Util::StringAtom	appName
Util::StringAtom	rootDirectory
Util::StringAtom	toolDirectory
bool	isOpen

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)

Constructor & Destructor Documentation

CoreServer()

Core::CoreServer::CoreServer

(

)

constructor

~CoreServer()

Core::CoreServer::~CoreServer ( )

virtual

destructor

Member Function Documentation

__DeclareClass()

Core::CoreServer::__DeclareClass ( CoreServer )

private

__DeclareSingleton()

Core::CoreServer::__DeclareSingleton ( CoreServer )

private

Close()

void Core::CoreServer::Close

(

)

close the core server

GetAppName()

const Util::StringAtom & Core::CoreServer::GetAppName ( ) const

inline

get the application name

GetCompanyName()

const Util::StringAtom & Core::CoreServer::GetCompanyName ( ) const

inline

get the company name

GetRootDirectory()

const Util::StringAtom & Core::CoreServer::GetRootDirectory ( ) const

inline

get the root directory of the application

GetToolDirectory()

const Util::StringAtom & Core::CoreServer::GetToolDirectory ( ) const

inline

get the tools directory

IsOpen()

bool Core::CoreServer::IsOpen ( ) const

inline

return true if currently open

Open()

void Core::CoreServer::Open

(

)

open the core server

SetAppName()

void Core::CoreServer::SetAppName ( const Util::StringAtom & s )

inline

set the application name

SetCompanyName()

void Core::CoreServer::SetCompanyName ( const Util::StringAtom & s )

inline

set the company name

SetRootDirectory()

void Core::CoreServer::SetRootDirectory ( const Util::StringAtom & s )

inline

set the root directory of the application (default is "home:")

SetToolDirectory()

void Core::CoreServer::SetToolDirectory ( const Util::StringAtom & s )

inline

set the tools directory ("tool:")

Trigger()

void Core::CoreServer::Trigger

(

)

trigger core server, updates console

Member Data Documentation

appName

Util::StringAtom Core::CoreServer::appName

private

companyName

Util::StringAtom Core::CoreServer::companyName

private

con

Ptr<IO::Console> Core::CoreServer::con

private

isOpen

bool Core::CoreServer::isOpen

private

rootDirectory

Util::StringAtom Core::CoreServer::rootDirectory

private

toolDirectory

Util::StringAtom Core::CoreServer::toolDirectory

private

---

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

• /github/workspace/code/foundation/core/coreserver.h
• /github/workspace/code/foundation/core/coreserver.cc