IHandler Interface Reference

A collection of handlers. More...

Inheritance diagram for IHandler:

Public Member Functions
	IHandler ()
	Create a TdjHandlerCollection.
	~IHandler ()
	Destructor.
	Handle (const string Target, TdjServerContext Context, TdjRequest Request, TdjResponse Response)
	Handles an HTTP request.
boolean	IsStarted ()
boolean	IsStopped ()
	Start ()
	Starts the component.
	Stop ()
	Stops the component.

Public Attributes
Boolean	StrictStart
	When True, a handler in this collection that fails to start makes Start raise instead of logging the failure and continuing with the remaining handlers.

Protected Member Functions
	AddHandler (const IHandler Handler)
	Handle (const string Target, TdjServerContext Context, TdjRequest Request, TdjResponse Response)
	RemoveHandler (const IHandler Handler)
	SetStrictStart (const Boolean Value)

Protected Attributes
TdjHandlers	FHandlers
	The handler collection.

Detailed Description

A collection of handlers.

Interface for HTTP request handlers.

For each request, all handler are called, regardless of the response status or exceptions.

Constructor & Destructor Documentation

IHandler()

IHandler::IHandler

(

)

Create a TdjHandlerCollection.

Referenced by SetStrictStart().

~IHandler()

IHandler::~IHandler

(

)

Destructor.

Member Function Documentation

AddHandler()

IHandler::AddHandler ( const IHandler Handler )

protected

Implemented in IHandlerContainer.

Referenced by SetStrictStart().

Handle() [1/2]

IHandler::Handle ( const string Target, TdjServerContext Context, TdjRequest Request, TdjResponse Response )

protected

Implemented in TdjAbstractHandler, TdjServerBase, and TdjWebComponentHandler.

References ILifeCycle::Start().

Handle() [2/2]

IHandler::Handle	(	const string	Target,
		TdjServerContext	Context,
		TdjRequest	Request,
		TdjResponse	Response )

Handles an HTTP request.

Parameters

Target	Target path or resource identifier
Context	Server context for this request
Request	HTTP request object
Response	HTTP response object to populate

Exceptions

EDarajaException

if an exception occurs that interferes with the component's normal operation.

Implemented in TdjAbstractHandler, TdjServerBase, and TdjWebComponentHandler.

IsStarted()

boolean ILifeCycle::IsStarted ( )

inherited

Returns

True if component is started

Implemented in TdjLifeCycle.

Referenced by TdjServer::ConnectorCount(), and Stop().

IsStopped()

boolean ILifeCycle::IsStopped ( )

inherited

Returns

True if component is stopped

Implemented in TdjLifeCycle.

RemoveHandler()

IHandler::RemoveHandler ( const IHandler Handler )

protected

Implemented in IHandlerContainer.

Referenced by SetStrictStart().

SetStrictStart()

IHandler::SetStrictStart ( const Boolean Value )

protected

Implemented in TdjWebComponentHandler.

References IHandler(), AddHandler(), and RemoveHandler().

Start()

ILifeCycle::Start ( )

inherited

Starts the component.

Implemented in TdjLifeCycle.

References Start().

Referenced by TdjServer::AddConnector(), IHandler::Handle(), TdjServer::RemoveConnector(), and Start().

Stop()

ILifeCycle::Stop ( )

inherited

Stops the component.

Note

Unlike Start, a failure in the custom stop code is logged and swallowed rather than re-raised; the component is still marked stopped.

Implemented in TdjLifeCycle.

References IsStarted().

Referenced by TdjServer::ConnectorCount().

Member Data Documentation

FHandlers

TdjHandlers IHandler::FHandlers

protected

The handler collection.

StrictStart

Boolean IHandler::StrictStart

When True, a handler in this collection that fails to start makes Start raise instead of logging the failure and continuing with the remaining handlers.

Defaults to False, preserving the collection's traditional best-effort behavior.

Setting this to True also propagates it to any handler in the collection that supports strict start itself (e.g. a nested context), so the setting reaches the whole subtree below this collection.

Exceptions

Exception

if this collection is already started.