Http::HttpServerProxy Class Reference

#include <httpserverproxy.h>

Detailed Description

Client-side proxy of the HttpServer.

Client threads create and attach HttpRequestHandlers to their HttpServerProxy. The HttpServerProxy receives incoming http requests from the http thread, and lets its HttpRequestHandlers process the request in the client thread's context, then sends the result back to the http thread.

Copyright

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

Inherits Core::RefCounted.

Public Member Functions
	HttpServerProxy ()
	constructor
virtual	~HttpServerProxy ()
	destructor
void	Open ()
	open the server proxy
void	Close ()
	close the server proxy
bool	IsOpen () const
	return true if open
void	AttachRequestHandler (const Ptr< Http::HttpRequestHandler > &h)
	attach a request handler to the server
void	RemoveRequestHandler (const Ptr< Http::HttpRequestHandler > &h)
	remove a request handler from the server
void	HandlePendingRequests ()
	handle pending http requests, call this method frequently
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 (HttpServerProxy)
	__DeclareSingleton (HttpServerProxy)

Private Attributes
Util::Array< Ptr< HttpRequestHandler > >	requestHandlers
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

HttpServerProxy()

Http::HttpServerProxy::HttpServerProxy

(

)

constructor

~HttpServerProxy()

Http::HttpServerProxy::~HttpServerProxy ( )

virtual

destructor

Member Function Documentation

__DeclareClass()

Http::HttpServerProxy::__DeclareClass ( HttpServerProxy )

private

__DeclareSingleton()

Http::HttpServerProxy::__DeclareSingleton ( HttpServerProxy )

private

AttachRequestHandler()

void Http::HttpServerProxy::AttachRequestHandler

(

const Ptr< Http::HttpRequestHandler > &

h

)

attach a request handler to the server

Close()

void Http::HttpServerProxy::Close

(

)

close the server proxy

HandlePendingRequests()

void Http::HttpServerProxy::HandlePendingRequests

(

)

handle pending http requests, call this method frequently

IsOpen()

bool Http::HttpServerProxy::IsOpen ( ) const

inline

return true if open

Open()

void Http::HttpServerProxy::Open

(

)

open the server proxy

RemoveRequestHandler()

void Http::HttpServerProxy::RemoveRequestHandler

(

const Ptr< Http::HttpRequestHandler > &

h

)

remove a request handler from the server

Member Data Documentation

isOpen

bool Http::HttpServerProxy::isOpen

private

requestHandlers

Util::Array<Ptr<HttpRequestHandler> > Http::HttpServerProxy::requestHandlers

private

---

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

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