glo::WatchNotifyManager::CommunicatorClientNotifyModes Class Reference

Monitoring or notification mode of client logins and logouts. More...

Inheritance diagram for glo::WatchNotifyManager::CommunicatorClientNotifyModes:

Public Member Functions
	CommunicatorClientNotifyModes (const CommunicatorCallBackIndex &rCommunicatorCallBackIndex)
virtual	~CommunicatorClientNotifyModes ()
virtual bool	hasWatches () const
void	setWatch (TdWatchNotifyMode tdWatchNotifyMode)
int	unsetWatch (TdWatchNotifyMode tdWatchNotifyMode, bool bSimulate=false)
Public Member Functions inherited from glo::WatchNotifyManager::CommunicatorNotifyModes
	CommunicatorNotifyModes (const CommunicatorCallBackIndex &rCommunicatorCallBackIndex)
virtual	~CommunicatorNotifyModes ()
NUM_PTR	getCallBackIndex ()
Communicator *	getCommunicator ()
WatchNotifyManager::CommunicatorCallBackIndex &	getCommunicatorCallBackIndex ()

Protected Member Functions
	CommunicatorClientNotifyModes ()
Protected Member Functions inherited from glo::WatchNotifyManager::CommunicatorNotifyModes
	CommunicatorNotifyModes ()

Private Attributes
int	m_iWNM_CLIENT_CLOSE_BASE
int	m_iWNM_CLIENT_CONNECT_SERVER
int	m_iWNM_CLIENT_DISCONNECT_SERVER
int	m_iWNM_CLIENT_OPEN_BASE

Detailed Description

Monitoring or notification mode of client logins and logouts.

Copyright

© 2010 Helmut Jakoby

Author

Helmut Jakoby

Constructor & Destructor Documentation

CommunicatorClientNotifyModes() [1/2]

glo::WatchNotifyManager::CommunicatorClientNotifyModes::CommunicatorClientNotifyModes ( )

protected

The standard constructor is not available.

CommunicatorClientNotifyModes() [2/2]

glo::WatchNotifyManager::CommunicatorClientNotifyModes::CommunicatorClientNotifyModes

(

const CommunicatorCallBackIndex &

rCommunicatorCallBackIndex

)

Constructor with parameter passing.

Parameters

[in]

rCommunicatorCallBackIndex

The client communicator CallBackIndex.

~CommunicatorClientNotifyModes()

virtual glo::WatchNotifyManager::CommunicatorClientNotifyModes::~CommunicatorClientNotifyModes ( )

virtual

Destructor.

Member Function Documentation

hasWatches()

virtual bool glo::WatchNotifyManager::CommunicatorClientNotifyModes::hasWatches ( ) const

virtual

Checks whether monitoring is set.

Returns

Returns true if any supervision is set.

Implements glo::WatchNotifyManager::CommunicatorNotifyModes.

setWatch()

void glo::WatchNotifyManager::CommunicatorClientNotifyModes::setWatch

(

TdWatchNotifyMode

tdWatchNotifyMode

)

Registers a monitoring for a client login.

Parameters

[in]

tdWatchNotifyMode

The monitoring mode to register for the client.

unsetWatch()

int glo::WatchNotifyManager::CommunicatorClientNotifyModes::unsetWatch	(	TdWatchNotifyMode	tdWatchNotifyMode,
		bool	bSimulate = false )

Deregisters a monitoring for a client login.

Parameters

[in]	tdWatchNotifyMode	The watch mode to be unregistered for the client.
[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_iWNM_CLIENT_CLOSE_BASE

int glo::WatchNotifyManager::CommunicatorClientNotifyModes::m_iWNM_CLIENT_CLOSE_BASE

private

Client database close monitoring counter.

m_iWNM_CLIENT_CONNECT_SERVER

int glo::WatchNotifyManager::CommunicatorClientNotifyModes::m_iWNM_CLIENT_CONNECT_SERVER

private

Client logon watchdog counter.

m_iWNM_CLIENT_DISCONNECT_SERVER

int glo::WatchNotifyManager::CommunicatorClientNotifyModes::m_iWNM_CLIENT_DISCONNECT_SERVER

private

Client logoff watchdog counter.

m_iWNM_CLIENT_OPEN_BASE

int glo::WatchNotifyManager::CommunicatorClientNotifyModes::m_iWNM_CLIENT_OPEN_BASE

private

Client Database open monitoring counter.

---

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

• GloWatchNotifyManager.h