The DtWebSpyHttpConnectionMgr is the abstract interface for the http connection manager side of the DtWebSpyServer. More...

Inheritance diagram for DtWebSpyHttpConnectionMgr:

Collaboration diagram for DtWebSpyHttpConnectionMgr:

List of all members.

Public Types
typedef DtWebSpyHttpConnectionMgr (	CreatorType )(DtWebSpyServer &parent)
	Web Spy HTTP Server creator method.
Public Member Functions
virtual	~DtWebSpyHttpConnectionMgr ()
	Dtor.
virtual void	tick (unsigned int timeout=0)=0
	Offer the web server processing time and Gets command messages from the HTTP server.
virtual void	addConnection (const DtWebSpyUtils::ConnectionIdentifier &connInfo)=0
	Add a new RTI object with associated connection information.
virtual void	updateConnection (const DtWebSpyUtils::ConnectionIdentifier &connInfo, std::auto_ptr< DtWebSpyUtils::ConnectionState > connState, bool appendToExisting)=0
	Update the state of an individual component behind an existing web server connection.
virtual void	appendConnectionLogEvent (const DtWebSpyUtils::ConnectionIdentifier &connInfo, unsigned long componentId, DtLrcConsoleLogXmlBlockSP logSegmentSP)=0
	Update the event log of an individual component behind an existing web server connection.
virtual void	removeConnection (const DtWebSpyUtils::ConnectionIdentifier &connInfo, const DtString &dropNotificationMsg="")=0
	Remove a connection and replace it with a disconnect message when its corresponding connection is dropped Caller may specify additional information about the reason for the drop via the optional dropNotificationMsg (accepts HTML)
const DtRIDParameters &	params () const
	Provide access to the RID parameters.
Static Public Member Functions
static DtWebSpyHttpConnectionMgr *	create (DtWebSpyServer &parent)
	Virtual constructor.
static void	setCreatorFunction (CreatorType creator)
	Set the concrete type for the virtual constructor method.
Protected Member Functions
	DtWebSpyHttpConnectionMgr (DtWebSpyServer &parent)
	Ctor protected since this is an abstract base.
Protected Attributes
unsigned int	myHttpPort
	The web server listening port.
bool	myIsCentralServer
	Will this web server forward page requests to remote network entities?
DtClock	myClock
	Timer for measuring timeouts.
DtWebSpyServer &	myParent
	The server to which this connection manager is attached.
Static Protected Attributes
static CreatorType	theCreatorFunction = 0
	HTTP connection manager creator method.
Private Member Functions
	DtWebSpyHttpConnectionMgr (const DtWebSpyHttpConnectionMgr &)
	Copy and Assignment unimplemented.
DtWebSpyHttpConnectionMgr &	operator= (DtWebSpyHttpConnectionMgr &)
	Copy and Assignment unimplmented.

Detailed Description

The DtWebSpyHttpConnectionMgr is the abstract interface for the http connection manager side of the DtWebSpyServer.

It is responsible for serving the client application and parsing requests from and responses to the client.

IMPORTANT: note that while multiple web clients may post commands, the responses simply update the page state - ie - they are not directed to a specific client the client must request an update to receive the updated state.

Member Typedef Documentation

typedef DtWebSpyHttpConnectionMgr*(* DtWebSpyHttpConnectionMgr::CreatorType)(DtWebSpyServer &parent)

Web Spy HTTP Server creator method.

Constructor & Destructor Documentation

DtWebSpyHttpConnectionMgr::DtWebSpyHttpConnectionMgr ( const DtWebSpyHttpConnectionMgr & ) [private]

Copy and Assignment unimplemented.

DtWebSpyHttpConnectionMgr::~DtWebSpyHttpConnectionMgr ( ) [virtual]

Dtor.

DtWebSpyHttpConnectionMgr::DtWebSpyHttpConnectionMgr ( DtWebSpyServer & parent ) [protected]

Ctor protected since this is an abstract base.

Member Function Documentation

virtual void DtWebSpyHttpConnectionMgr::addConnection ( const DtWebSpyUtils::ConnectionIdentifier & connInfo ) [pure virtual]

Add a new RTI object with associated connection information.

Implemented in DtEhsHttpConnectionMgr.

virtual void DtWebSpyHttpConnectionMgr::appendConnectionLogEvent	(	const DtWebSpyUtils::ConnectionIdentifier &	connInfo,
		unsigned long	componentId,
		DtLrcConsoleLogXmlBlockSP	logSegmentSP
	)		`[pure virtual]`

Update the event log of an individual component behind an existing web server connection.

events are timestamped so that client may request a sub-set of the logged events ( i.e. - the 50 most recent events )

Implemented in DtEhsHttpConnectionMgr.

DtWebSpyHttpConnectionMgr * DtWebSpyHttpConnectionMgr::create ( DtWebSpyServer & parent ) [static]

Virtual constructor.

Reimplemented in DtEhsHttpConnectionMgr.

References theCreatorFunction.

DtWebSpyHttpConnectionMgr& DtWebSpyHttpConnectionMgr::operator= ( DtWebSpyHttpConnectionMgr & ) [private]

Copy and Assignment unimplmented.

const DtRIDParameters & DtWebSpyHttpConnectionMgr::params ( ) const

Provide access to the RID parameters.

References myParent, and DtWebSpyServer::params().

Referenced by DtWwwDocRoot::DtWwwDocRoot().

virtual void DtWebSpyHttpConnectionMgr::removeConnection	(	const DtWebSpyUtils::ConnectionIdentifier &	connInfo,
		const DtString &	dropNotificationMsg = `""`
	)		`[pure virtual]`

Remove a connection and replace it with a disconnect message when its corresponding connection is dropped Caller may specify additional information about the reason for the drop via the optional dropNotificationMsg (accepts HTML)

Implemented in DtEhsHttpConnectionMgr.

void DtWebSpyHttpConnectionMgr::setCreatorFunction ( CreatorType creator ) [static]

Set the concrete type for the virtual constructor method.

References theCreatorFunction.

virtual void DtWebSpyHttpConnectionMgr::tick ( unsigned int timeout = 0 ) [pure virtual]

Offer the web server processing time and Gets command messages from the HTTP server.

commands from the HTTP server are simple xml command messages encoded by the client
commands must be decoded by the wwwSpyServer decoder

Implemented in DtEhsHttpConnectionMgr.

virtual void DtWebSpyHttpConnectionMgr::updateConnection	(	const DtWebSpyUtils::ConnectionIdentifier &	connInfo,
		std::auto_ptr< DtWebSpyUtils::ConnectionState >	connState,
		bool	appendToExisting
	)		`[pure virtual]`