glo::WatchNotifyManager::IndexReadWriteWatch Class Reference

Monitoring class for read-index, write-index and reindex actions of the database. More...

Public Member Functions
	IndexReadWriteWatch ()
	~IndexReadWriteWatch ()
void	deleteAllWatches (Communicator *pCommunicator)
std::size_t	getCommunicatorIndexReadWriteNotifyModesMapCount () 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	clearCommunicatorIndexReadWriteNotifyModesMap ()

Private Attributes
std::map< CommunicatorCallBackIndex, CommunicatorIndexReadWriteNotifyModes *, std::less< CommunicatorCallBackIndex > >	m_CommunicatorIndexReadWriteNotifyModesMap

Detailed Description

Monitoring class for read-index, write-index and reindex actions of the database.

Copyright

© 2010 Helmut Jakoby

Author

Helmut Jakoby

Constructor & Destructor Documentation

IndexReadWriteWatch()

glo::WatchNotifyManager::IndexReadWriteWatch::IndexReadWriteWatch

(

)

Standard constructor.

~IndexReadWriteWatch()

glo::WatchNotifyManager::IndexReadWriteWatch::~IndexReadWriteWatch

(

)

Destructor.

Member Function Documentation

clearCommunicatorIndexReadWriteNotifyModesMap()

void glo::WatchNotifyManager::IndexReadWriteWatch::clearCommunicatorIndexReadWriteNotifyModesMap ( )

protected

Removes all read-index, write-index or reindex monitoring.

deleteAllWatches()

void glo::WatchNotifyManager::IndexReadWriteWatch::deleteAllWatches

(

Communicator *

pCommunicator

)

Removes all monitoring of the transferred client communicator.

Parameters

[in]

pCommunicator

The client communicator.

getCommunicatorIndexReadWriteNotifyModesMapCount()

std::size_t glo::WatchNotifyManager::IndexReadWriteWatch::getCommunicatorIndexReadWriteNotifyModesMapCount

(

)

const

Returns the number of read-index, write-index and reindex monitors.

hasWatches()

bool glo::WatchNotifyManager::IndexReadWriteWatch::hasWatches

(

)

const

Checks if read-index, write-index or reindex monitors are set.

Returns

Returns true if any supervision is set.

setWatch()

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

Registers a monitoring for the read-index, write-index or reindex.

Parameters

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

unsetWatch()

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

Deregisters a monitoring for the read-index, write-index or reindex.

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_CommunicatorIndexReadWriteNotifyModesMap

std::map< CommunicatorCallBackIndex, CommunicatorIndexReadWriteNotifyModes *, std::less<CommunicatorCallBackIndex> > glo::WatchNotifyManager::IndexReadWriteWatch::m_CommunicatorIndexReadWriteNotifyModesMap

private

The individual CommunicatorIndexReadWriteNotifyModes of the read index, write index and reindex actions of the database with the CommunicatorCallBackIndex as index in a map.

---

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

• GloWatchNotifyManager.h