glo::WatchNotifyManager::ClientWatch Class Reference

Monitoring class for client logins and logouts. More...

Public Member Functions
	ClientWatch ()
	~ClientWatch ()
void	deleteAllWatches (Communicator *pCommunicator)
std::size_t	getCommunicatorClientNotifyModesMapCount () const
bool	hasWatches () const
void	setWatch (const CommunicatorCallBackIndex &rCommunicatorCallBackIndex, TdWatchNotifyMode tdWatchNotifyMode)
int	unsetWatch (const CommunicatorCallBackIndex &rCommunicatorCallBackIndex, TdWatchNotifyMode tdWatchNotifyMode, bool bSimulate=false)

Protected Member Functions
void	clearCommunicatorClientNotifyModesMap ()

Private Attributes
std::map< CommunicatorCallBackIndex, CommunicatorClientNotifyModes *, std::less< CommunicatorCallBackIndex > >	m_CommunicatorClientNotifyModesMap

Detailed Description

Monitoring class for client logins and logouts.

Copyright

© 2010 Helmut Jakoby

Author

Helmut Jakoby

Constructor & Destructor Documentation

ClientWatch()

glo::WatchNotifyManager::ClientWatch::ClientWatch

(

)

Standard constructor.

~ClientWatch()

glo::WatchNotifyManager::ClientWatch::~ClientWatch

(

)

Destructor.

Member Function Documentation

clearCommunicatorClientNotifyModesMap()

void glo::WatchNotifyManager::ClientWatch::clearCommunicatorClientNotifyModesMap ( )

protected

Removes all client login and logout monitoring.

deleteAllWatches()

void glo::WatchNotifyManager::ClientWatch::deleteAllWatches

(

Communicator *

pCommunicator

)

Removes all monitoring of the transferred client communicator.

Parameters

[in]

pCommunicator

The client communicator.

getCommunicatorClientNotifyModesMapCount()

std::size_t glo::WatchNotifyManager::ClientWatch::getCommunicatorClientNotifyModesMapCount

(

)

const

Returns the number of client login and logout monitors.

Returns

The number of CommunicatorClientNotifyModes.

hasWatches()

bool glo::WatchNotifyManager::ClientWatch::hasWatches

(

)

const

Checks if client login and logout monitors are set.

Returns

Returns true if any supervision is set.

setWatch()

void glo::WatchNotifyManager::ClientWatch::setWatch	(	const CommunicatorCallBackIndex &	rCommunicatorCallBackIndex,
		TdWatchNotifyMode	tdWatchNotifyMode )

Registers a monitoring for the client login and logout.

Parameters

[in]	rCommunicatorCallBackIndex	The client communicator that wants to monitor.
[in]	tdWatchNotifyMode	The activated monitoring mode.

unsetWatch()

int glo::WatchNotifyManager::ClientWatch::unsetWatch	(	const CommunicatorCallBackIndex &	rCommunicatorCallBackIndex,
		TdWatchNotifyMode	tdWatchNotifyMode,
		bool	bSimulate = false )

Deregisters a monitoring for the client login and logout.

Parameters

[in]	rCommunicatorCallBackIndex	The client communicator that has monitored.
[in]	tdWatchNotifyMode	The suspended monitoring mode.
[in]	bSimulate	If true, only simulation is performed, no value is set, but a result or error is returned.

Returns

A return value > 0 indicates that the monitoring mode was switched off; however, there are still as many monitoring modes as specified in the return value.
A return == 0 indicates that the monitoring mode has been switched off and there are no further monitoring modes!
A return value < 0 indicates an error.

Member Data Documentation

m_CommunicatorClientNotifyModesMap

std::map< CommunicatorCallBackIndex, CommunicatorClientNotifyModes *, std::less<CommunicatorCallBackIndex> > glo::WatchNotifyManager::ClientWatch::m_CommunicatorClientNotifyModesMap

private

The individual CommunicatorClassNotifyModes of the monitored client with the CommunicatorCallBackIndex as index in a map.

---

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

• GloWatchNotifyManager.h