Http::HttpMessageHandler Class Reference

#include <httpmessagehandler.h>

Detailed Description

Runs the HttpServer thread, and owns the central http server.

Processes messages sent to the HttpInterface from other threads.

Copyright

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

Inherits Interface::InterfaceHandlerBase.

Public Member Functions
	HttpMessageHandler ()
	constructor
virtual	~HttpMessageHandler ()
	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
virtual void	DoWork ()
	do per-frame work
void	SetTcpPort (ushort port)
	set tcpPort
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
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

Private Member Functions
	__DeclareClass (HttpMessageHandler)
void	OnAttachRequestHandler (const Ptr< AttachRequestHandler > &msg)
	handle AttachRequestHandler message
void	OnRemoveRequestHandler (const Ptr< RemoveRequestHandler > &msg)
	handle RemoveRequestHandler message

Private Attributes
ushort	DefaultTcpPort
Ptr< HttpServer >	httpServer

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)
Protected Attributes inherited from Interface::InterfaceHandlerBase
Util::StringAtom	companyName
Util::StringAtom	appName
Protected Attributes inherited from Messaging::Handler
bool	isOpen

Constructor & Destructor Documentation

HttpMessageHandler()

Http::HttpMessageHandler::HttpMessageHandler

(

)

constructor

~HttpMessageHandler()

Http::HttpMessageHandler::~HttpMessageHandler ( )

virtual

destructor

Member Function Documentation

__DeclareClass()

Http::HttpMessageHandler::__DeclareClass ( HttpMessageHandler )

private

Close()

void Http::HttpMessageHandler::Close ( )

virtual

close the handler

Reimplemented from Messaging::Handler.

DoWork()

void Http::HttpMessageHandler::DoWork ( )

virtual

do per-frame work

Triggers the http server from time to time.

Reimplemented from Interface::InterfaceHandlerBase.

HandleMessage()

bool Http::HttpMessageHandler::HandleMessage ( const Ptr< Messaging::Message > & msg )

virtual

handle a message, return true if handled

Reimplemented from Messaging::Handler.

OnAttachRequestHandler()

void Http::HttpMessageHandler::OnAttachRequestHandler ( const Ptr< AttachRequestHandler > & msg )

private

handle AttachRequestHandler message

OnRemoveRequestHandler()

void Http::HttpMessageHandler::OnRemoveRequestHandler ( const Ptr< RemoveRequestHandler > & msg )

private

handle RemoveRequestHandler message

Open()

void Http::HttpMessageHandler::Open ( )

virtual

open the handler

Reimplemented from Messaging::Handler.

SetTcpPort()

void Http::HttpMessageHandler::SetTcpPort ( ushort port )

inline

set tcpPort

Member Data Documentation

DefaultTcpPort

ushort Http::HttpMessageHandler::DefaultTcpPort

private

httpServer

Ptr<HttpServer> Http::HttpMessageHandler::httpServer

private

---

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

• /github/workspace/code/foundation/http/httpmessagehandler.h
• /github/workspace/code/foundation/http/httpmessagehandler.cc