Dokumentace rozhraní Grendel::Communication::ICommunicator

Rozhraní objektů zajišťujících komunikaci mezi objekty aplikace. Komunikující objekty se sdružují do pojmenovaných komunikačních skupin prostřednictvím registrace u komunikátoru. Následně lze posílat zprávy všem objektům ve skupině. KOmunikátor je implementací návrhového vzoru "Pozorovatel" (Observer). ...

Diagram dědičnosti pro třídu Grendel::Communication::ICommunicator

Grendel::Communication::LocalCommunicator

Seznam všech členů.

Veřejné metody

int SendMessage (string targetGroup, object message)
 zaslání zprávy všem čelnům dané komunikační (cílové) skupiny
void Subscribe (string targetGroup, IMessageReceiver receiver)
 registrace do nové komunikační skupiny. Prvním parametrem je jméno skupiny druhým reference na objekt příjemce (tomuto objektu budou doručovány zprávy, typicky to bývá objekt this). Pokud skupina existuje je objekt přidán do skupiny, jinak je vytvořena skupina nová. Metoda vrací aktuální počet objektů ve skupině po provedení registrace (pouze informativní údaj, počet se může dále měnit)
void SignOff (string targetGroup, IMessageReceiver receiver)
 Odhlášení z komunikační skupiny.

Vlastnosti

string UniqueGroupIdentifier [get]


Detailní popis

Rozhraní objektů zajišťujících komunikaci mezi objekty aplikace. Komunikující objekty se sdružují do pojmenovaných komunikačních skupin prostřednictvím registrace u komunikátoru. Následně lze posílat zprávy všem objektům ve skupině. KOmunikátor je implementací návrhového vzoru "Pozorovatel" (Observer).

Definice je uvedena na řádku 18 v souboru Communicator.cs.


Dokumentace k metodám

int Grendel::Communication::ICommunicator::SendMessage ( string  targetGroup,
object  message 
)

zaslání zprávy všem čelnům dané komunikační (cílové) skupiny

Implementováno v Grendel::Communication::LocalCommunicator.

void Grendel::Communication::ICommunicator::Subscribe ( string  targetGroup,
IMessageReceiver  receiver 
)

registrace do nové komunikační skupiny. Prvním parametrem je jméno skupiny druhým reference na objekt příjemce (tomuto objektu budou doručovány zprávy, typicky to bývá objekt this). Pokud skupina existuje je objekt přidán do skupiny, jinak je vytvořena skupina nová. Metoda vrací aktuální počet objektů ve skupině po provedení registrace (pouze informativní údaj, počet se může dále měnit)

Implementováno v Grendel::Communication::LocalCommunicator.

void Grendel::Communication::ICommunicator::SignOff ( string  targetGroup,
IMessageReceiver  receiver 
)

Odhlášení z komunikační skupiny.

Implementováno v Grendel::Communication::LocalCommunicator.


Dokumentace k vlastnosti

string Grendel::Communication::ICommunicator::UniqueGroupIdentifier [get]

vrací unikátní identifikátor skupiny. Vhodné v situacích, kdy by měl komunikační skupinu tvoří jediný objekt (posílání zpráv nahrazuje přímé volání metod daného objektu)

Implementováno v Grendel::Communication::LocalCommunicator.

Definice je uvedena na řádku 41 v souboru Communicator.cs.


Dokumentace pro toto rozhraní byla generována z následujícího souboru:

Generováno Sun Jul 12 20:34:44 2009 pro projekt Grafická knihovna GRENDEL programem  doxygen 1.5.5