Http::HttpRequestHandler Class Reference
#include <httprequesthandler.h>
Inheritance diagram for Http::HttpRequestHandler:
Detailed Description
HttpRequestHandlers are attached to the HttpServer and process incoming HTTP requests. When an Http request comes in, the HttpServer asks every attached HttpRequestHandler until the first one accepts the request. If the HttpRequestHandler accepts the request its HandleRequest() method will be called with a pointer to a content stream. The request handler is expected to write the response to the content stream (IMPORTANT: don't forget to set the MediaType on the stream!) and return with a HttpStatus code.(C) 2007 Radon Labs GmbH
Public Member Functions | |
| HttpRequestHandler () | |
| constructor | |
| virtual | ~HttpRequestHandler () |
| destructor | |
| const Util::String & | GetName () const |
| get a human readable name of the request handler | |
| const Util::String & | GetDesc () const |
| get a human readable description of the request handler | |
| const Util::String & | GetRootLocation () const |
| get a resource location path which is accepted by the handler (e.g. "/display") | |
| 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 | |
Static Public Member Functions | |
| static void | DumpRefCountingLeaks () |
| dump refcounting leaks, call at end of application (NEBULA3_DEBUG builds only!) | |
Protected Member Functions | |
| virtual void | HandleRequest (const Ptr< HttpRequest > &request) |
| handle a http request, overwrite this method in you subclass | |
| void | HandlePendingRequests () |
| handle all pending requests, called by local-thread's HttpServerProxy | |
| void | PutRequest (const Ptr< HttpRequest > &httpRequest) |
| put a request to the pending queue, called by HttpServer thread | |
| void | SetName (const Util::String &n) |
| set human readable name of the request handler | |
| void | SetDesc (const Util::String &d) |
| set human readable description | |
| void | SetRootLocation (const Util::String &l) |
| set the root location of the request handler | |
Member Function Documentation
| void Http::HttpRequestHandler::HandleRequest | ( | const Ptr< HttpRequest > & | request | ) | [protected, virtual] |
handle a http request, overwrite this method in you subclass
Overwrite this method in your subclass. This method will be called by the HttpServer if AcceptsRequest() returned true. The request handler should properly process the request by filling the responseContentStream with data (for instance a HTML page), set the MediaType on the responseContentStream (for instance "text/html") and return with a HttpStatus code (usually HttpStatus::OK).
Reimplemented in Debug::CorePageHandler, Debug::DebugPageHandler, Debug::HelloWorldRequestHandler, Debug::SvgTestPageHandler, Http::DefaultHttpRequestHandler, Debug::ConsolePageHandler, Debug::IoPageHandler, Debug::MemoryPageHandler, Debug::ThreadPageHandler, Debug::DisplayPageHandler, Debug::MeshPageHandler, Debug::ShaderPageHandler, Debug::TexturePageHandler, Debug::GraphicsPageHandler, Debug::StreamingTexturePageHandler, and Debug::ObjectInspectorHandler.
| void Http::HttpRequestHandler::HandlePendingRequests | ( | ) | [protected] |
handle all pending requests, called by local-thread's HttpServerProxy
Handle all pending http requests in the pending queue. This method must be called frequently from the thread which created this request handler.
| void Http::HttpRequestHandler::PutRequest | ( | const Ptr< HttpRequest > & | httpRequest | ) | [protected] |
put a request to the pending queue, called by HttpServer thread
Put a http request into the request handlers message queue. This method is meant to be called from another thread.
| 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.