The Nebula Device 3: Http::HttpServer Class Reference

The Nebula Device 3

Http::HttpServer Class Reference

#include <httpserver.h>

Inheritance diagram for Http::HttpServer:

Core::RefCounted

Detailed Description

Implements an extremly simple standalone HTTP server with attached HttpRequestHandlers. Can be used to serve debug information about the Nebula3 application to web browsers.

(C) 2007 Radon Labs GmbH

Public Member Functions

 HttpServer ()
 constructor
virtual ~HttpServer ()
 destructor
void SetPort (ushort p)
 set port number for http service
ushort GetPort () const
 get port number of http service
void SetSingleThreadMode (bool b)
 turn single-thread mode on/off (useful for debugging), default is off
bool IsSingleThreadMode () const
 get single-thread mode
bool Open ()
 open the http server
void Close ()
 close the http server
bool IsOpen () const
 return true if server is open
void AttachRequestHandler (const Ptr< HttpRequestHandler > &h)
 attach a request handler to the server
void RemoveRequestHandler (const Ptr< HttpRequestHandler > &h)
 remove a request handler from the server
Util::Array< Ptr< HttpRequestHandler > > GetRequestHandlers () const
 get registered request handlers
void OnFrame ()
 call this method frequently to serve http connections
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::StringGetClassName () 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!)

Member Function Documentation

void Http::HttpServer::SetSingleThreadMode ( bool  b  )  [inline]

turn single-thread mode on/off (useful for debugging), default is off

Switch on single thread mode, default is off. In single thread mode, http requests will be processed immediately in the OnFrame() method, not added to the request handler for asynchronous processing. This may be useful for debugging, but is dangerous/impossible if HTTP request handlers live in different threads!!!

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.