glo::WatchNotifyManager::ClientWatch Klassenreferenz

Überwachungsklasse für Client-An- bzw. Abmeldungen. Mehr ...

Öffentliche Methoden
	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)

Geschützte Methoden
void	clearCommunicatorClientNotifyModesMap ()

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

Ausführliche Beschreibung

Überwachungsklasse für Client-An- bzw. Abmeldungen.

Copyright

© 2010 Helmut Jakoby

Autor

Helmut Jakoby

Beschreibung der Konstruktoren und Destruktoren

ClientWatch()

glo::WatchNotifyManager::ClientWatch::ClientWatch

(

)

Standard-Konstruktor.

~ClientWatch()

glo::WatchNotifyManager::ClientWatch::~ClientWatch

(

)

Destruktor.

Dokumentation der Elementfunktionen

clearCommunicatorClientNotifyModesMap()

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

protected

Entfernt alle Client-An- und Abmelde-Überwachungen.

deleteAllWatches()

void glo::WatchNotifyManager::ClientWatch::deleteAllWatches

(

Communicator *

pCommunicator

)

Entfernt alle Überwachungen des übergebenen Client-Kommunikators.

Parameter

[in]

pCommunicator

Der Client-Kommunikators.

getCommunicatorClientNotifyModesMapCount()

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

(

)

const

Liefert die Anzahl der Client-An- und Abmelde-Überwachungen.

Rückgabe

Die Anzahl der CommunicatorClientNotifyModes.

hasWatches()

bool glo::WatchNotifyManager::ClientWatch::hasWatches

(

)

const

Prüft ob Client-An- und Abmelde-Überwachungen gesetzt sind.

Rückgabe

Liefert true, wenn Überwachungen gesetzt sind.

setWatch()

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

Registriert eine Client-An- und Abmelde-Überwachung.

Parameter

[in]	rCommunicatorCallBackIndex	Der Client-Kommunikator, der überwachen möchte.
[in]	tdWatchNotifyMode	Der aktivierte Überwachungsmodus.

unsetWatch()

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

Deregistriert die Client-An- und Abmelde-Überwachung.

Parameter

[in]	rCommunicatorCallBackIndex	Der Client-Kommunikator, der überwacht hat
[in]	tdWatchNotifyMode	Der zu deregistrierende Überwachungsmodus für den Client.
[in]	bSimulate	Wenn true, wird nur simuliert, also kein Wert gesetzt, aber ein Ergebnis bzw. Fehler geliefert.

Rückgabe

Eine Rückgabe > 0 zeigt an, dass der Überwachungsmodus abgeschaltet wurde; es existieren aber noch soviele Überwachungsmodi wie in der Rückgabeanzahl angegeben.
Eine Rückgabe == 0 zeigt an, dass der Überwachungsmodus abgeschaltet wurde und es keine weiteren Überwachungsmodi gibt!
Eine Rückgabe < 0 zeigt einen Fehler an.

Dokumentation der Datenelemente

m_CommunicatorClientNotifyModesMap

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

private

Die einzelnen CommunicatorClientNotifyModes des überwachten Clients mit dem CommunicatorCallBackIndex als Index in einer Map.

---

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:

• GloWatchNotifyManager.h