Riferimenti per la classe ChatRoom

#include <ChatRoom.h>

Diagramma delle classi per ChatRoom

[legenda]Diagramma di collaborazione per ChatRoom:

[legenda]Lista di tutti i membri.

---

Descrizione Dettagliata

ChatRoom per MGS: un esempio di implementazione di Game.

Questa classe e' un esempio di implementazione dell'interfaccia Game.
Permette di gestire una semplice ChatRoom con scambio di messaggi tra gli utenti presenti.
Per questo Game non e' stato necessario re-implementare la classe Player perche' essa risulta sufficiente per questo uso.

Definizione alla linea 31 del file ChatRoom.h.

Membri pubblici
	ChatRoom (void)
	Costruttore di default della Classe ChatRoom.
	ChatRoom (Player *)
	Costruttore overlodato della Classe ChatRoom.
virtual	~ChatRoom (void)
	Distruttore della Classe ChatRoom.
void	init (void)
	Inizializzazione della ChatRoom.
void	run (void)
	Flusso di Controllo di ChatRoom.
void	final (void)
	Chiusura della ChatRoom.
void	addPlayer (Player *)
	Aggiungi un Player alla ChatRoom.
bool	delPlayer (const string &)
	Rimuovi un Player dalla ChatRoom (overloaded).
int	getNumPlayers (void) const
	Ritorna il numero di Player presenti nella ChatRoom.
void	printPlayersList (iostream *)
	Stampa la lista dei Player presenti nella ChatRoom.
string	getName (void) const
	Ritorna il nome del Game.
Membri protetti
void	sayToAll (const string &, Player *=NULL)
	Invia un messaggio a tutti i Player della ChatRoom.
void	delPlayer (Player *)
	Rimuovi un Player dalla ChatRoom (overloaded).
Attributi privati
list< Player * >	playerList
	Lista dei Player presenti nella ChatRoom.
Mutex	mutex
	Mutex (Semaforo) utile per le Sezioni Critiche.

---

Documentazione dei costruttori e dei distruttori

ChatRoom::ChatRoom (  void   )

Costruttore di default della Classe ChatRoom. Definizione alla linea 11 del file ChatRoom.cc. {}

ChatRoom::ChatRoom (  Player *  firstPlayer  )

Costruttore overlodato della Classe ChatRoom. Parametri: firstPlayer  Primo giocatore della nuova ChatRoom Definizione alla linea 17 del file ChatRoom.cc. Riferimenti addPlayer(). { addPlayer(firstPlayer); }

Questo è il grafo delle chiamate per questa funzione:

ChatRoom::~ChatRoom (  void   )  [virtual]

Distruttore della Classe ChatRoom. Definizione alla linea 22 del file ChatRoom.cc. {exit();}

---

Documentazione delle funzioni membro

void ChatRoom::addPlayer (  Player *  newPlayer  )  [virtual]

Aggiungi un Player alla ChatRoom. Un messaggio di Benvenuto viene inviato all'utente e gli altri partecipanti alla ChatRoom vengono avvertiti dell'arrivo del nuovo Player. Parametri: newPlayer  Nuovo giocatore. Implementa Game. Definizione alla linea 131 del file ChatRoom.cc. Riferimenti Player::getName(), mutex, playerList, Player::say(), e sayToAll(). Referenziato da ChatRoom(). { mutex.enterMutex(); playerList.push_back(newPlayer); /* Messaggi di Benvenuto */ /* ...per il nuovo utente... */ newPlayer->say("\n<----------------------------------------->\n"); newPlayer->say(">>>>> Hello at MGS's ChatRoom <<<<<\n"); newPlayer->say("<----------------------------------------->\n\n"); newPlayer->say("[Users On-Line: "); newPlayer->say((int)(playerList.size() -1)); newPlayer->say("]\n"); /* ...per i restanti... */ sayToAll("<ChatRoom msg> " + newPlayer->getName() + " has joined at this ChatRoom\n", newPlayer); cout << "<ChatRoom msg> " << newPlayer->getName() << " has joined at this ChatRoom\n"; /* Riattiva o Avvia il Thread se l'utente appena inserito e' * l'unico */ if ( playerList.size() == 1 ) { if ( isRunning() ) resume(); else start(); } mutex.leaveMutex(); }

Questo è il grafo delle chiamate per questa funzione:

void ChatRoom::delPlayer (  Player *  toDelete  )  [protected]

Rimuovi un Player dalla ChatRoom (overloaded). Un messaggio di Arrivederci viene inviato all'utente e gli altri partecipanti alla ChatRoom vengono avvertiti. Parametri: toDelete  Puntatore al Player da eliminare. Definizione alla linea 200 del file ChatRoom.cc. Riferimenti Player::getName(), mutex, playerList, Player::resumeConnHandler(), Player::say(), e sayToAll(). { mutex.enterMutex(); toDelete->say("<ChatRoom msg> GoodBye. ;-)\n"); sayToAll("<ChatRoom msg> " + toDelete->getName() + " has leaved this ChatRoom\n", toDelete); toDelete->resumeConnHandler(); playerList.remove(toDelete); mutex.leaveMutex(); }

Questo è il grafo delle chiamate per questa funzione:

bool ChatRoom::delPlayer (  const string &  toDelete  )  [virtual]

Rimuovi un Player dalla ChatRoom (overloaded). Un messaggio di Arrivederci viene inviato all'utente e gli altri partecipanti alla ChatRoom vengono avvertiti. Parametri: toDelete  Nome del Player da eliminare. Restituisce: true se il Player viene trovato e rimosso, false altrimenti Implementa Game. Definizione alla linea 169 del file ChatRoom.cc. Riferimenti mutex, playerList, e sayToAll(). Referenziato da run(). { list<Player *>::iterator pli; mutex.enterMutex(); pli = playerList.begin(); while ( pli != playerList.end() ) { if ( (*pli)->getName() == toDelete) { /* Se il player é presente: * 1) riceve un messaggio di arrivederci * 2) Viene riattivato il suo ConnectionHandler * 3) Viene eliminato dalla lista */ (*pli)->say("<ChatRoom msg> GoodBye. ;-)\n"); sayToAll("<ChatRoom msg> " + (*pli)->getName() + " has leaved this ChatRoom\n", *pli); (*pli)->resumeConnHandler(); playerList.remove(*pli); mutex.leaveMutex(); return true; } pli++; } mutex.leaveMutex(); return false; }

Questo è il grafo delle chiamate per questa funzione:

void ChatRoom::final (  void   )  [virtual]

Chiusura della ChatRoom. Metodo ereditato da Thread, richiamato (automaticamente dalla Librerie) alla fine del metodo run(). Gestisce la corretta chiusura della ChatRoom: viene richiamato al termine del metodo "run()" o del metodo "exit()". Implementa Game. Definizione alla linea 101 del file ChatRoom.cc. Riferimenti mutex, e playerList. { if ( playerList.size() > 0 ) { list<Player *>::iterator pli; Player *temp; mutex.enterMutex(); while ( pli != playerList.end() ) { /* Se il player e' presente: * 1) riceve un messaggio di arrivederci * 2) Viene riattivato il suo ConnectionHandler * 3) Viene eliminato dalla lista */ (*pli)->say("<ChatRoom msg> ChatRoom Terminated. Now exit.\n"); (*pli)->resumeConnHandler(); temp = *pli; pli++; playerList.remove(temp); } mutex.leaveMutex(); } }

string ChatRoom::getName (  void   )  const [virtual]

Ritorna il nome del Game. Restituisce: Ritorna il Nome del Game Implementa Game. Definizione alla linea 232 del file ChatRoom.cc. {return "ChatRoom - Simple Chat for MGS";}

int ChatRoom::getNumPlayers (  void   )  const [virtual]

Ritorna il numero di Player presenti nella ChatRoom. Restituisce: Ritorna il numero di Player presenti nella ChatRoom Implementa Game. Definizione alla linea 214 del file ChatRoom.cc. Riferimenti playerList. { return playerList.size(); }

void ChatRoom::init (  void   )  [virtual]

Inizializzazione della ChatRoom. Metodo vuoto ereditato da Game. Implementa Game. Definizione alla linea 27 del file ChatRoom.cc. {}

void ChatRoom::printPlayersList (  iostream *  streamWherePrint  )  [virtual]

Stampa la lista dei Player presenti nella ChatRoom. Implementa Game. Definizione alla linea 219 del file ChatRoom.cc. Riferimenti mutex, e playerList. { list<Player *>::iterator pli; mutex.enterMutex(); pli = playerList.begin(); while ( pli != playerList.end() ) { *streamWherePrint << "\t* " << (*pli)->getName() << endl; pli++; } mutex.leaveMutex(); }

void ChatRoom::run (  void   )  [virtual]

Flusso di Controllo di ChatRoom. Questo metodo rappresenta il Flusso di Controllo principale del Thread. Qui' e' concentrato il funzionamento della ChatRoom. Implementa Game. Definizione alla linea 34 del file ChatRoom.cc. Riferimenti delPlayer(), playerList, e sayToAll(). { string message; string completeMessage; list<Player *>::iterator pli; char time_buffer[64]; int last; time_t t; tm *tbp; string now; while (true) { if ( playerList.size() == 0 ) { cout << "<ChatRoom msg> ChatRoom Empty: Suspended." << endl; suspend(); cout << "<ChatRoom msg> ChatRoom Resumed." << endl; } pli = playerList.begin(); while ( pli != playerList.end() ) { /* Recupera eventuale messaggio digitato dall'utente: * attende 5 decimi di secondo */ message = (*pli)->hear(500); /* Calcola l'ora e la data corrente. */ t = std::time(NULL); tbp = std::localtime(&t); last = std::strftime(time_buffer, 64, "%Y-%m-%d %H:%M:%S", tbp); time_buffer[last] = '\0'; now = time_buffer; /* Costruisce il Messaggio */ completeMessage = "[" + now + "] "; completeMessage += (*pli)->getName(); completeMessage += " >>> " + message + "\n"; if ( !message.empty() ) { if ( !strcmp(message.data(), "\\quit") ) { delPlayer(*pli); break; } else { /* Invia il messaggio a tutti, tranne che * al Player "pli" */ sayToAll(completeMessage, *pli); } } pli++; /* e' necessario ripulire la stringa del messaggio dell'utente */ message.clear(); } /* Attendiamo 2 decimi di second prima di ricominciare * a trasmettere messaggi. */ sleep(200); } }

Questo è il grafo delle chiamate per questa funzione:

void ChatRoom::sayToAll (  const string &  message, Player *  notSay = NULL )  [protected]

Invia un messaggio a tutti i Player della ChatRoom. Questo metodo e' utilizzato per "girare" i messaggi digitati da un Player a tutti gli altri Player presenti nella ChatRoom. Parametri: message  Stringa del messaggio da Inviare notSay  Puntato del Player a cui NON INVIARE il messaggio (probabilmente e' colui che l'ha scritto). Definizione alla linea 243 del file ChatRoom.cc. Riferimenti playerList. Referenziato da addPlayer(), delPlayer(), e run(). { list<Player *>::iterator pli; pli = playerList.begin(); while ( pli != playerList.end() ) { if ( notSay == NULL || (notSay != NULL && *pli != notSay) ) (*pli)->say(message); pli++; } }

---

Documentazione dei dati membri

Mutex ChatRoom::mutex [private]

Mutex (Semaforo) utile per le Sezioni Critiche. Definizione alla linea 53 del file ChatRoom.h. Referenziato da addPlayer(), delPlayer(), final(), e printPlayersList().

list<Player *> ChatRoom::playerList [private]

Lista dei Player presenti nella ChatRoom. Definizione alla linea 51 del file ChatRoom.h. Referenziato da addPlayer(), delPlayer(), final(), getNumPlayers(), printPlayersList(), run(), e sayToAll().

---

La documentazione per questa classe è stata generata a partire dai seguenti file:

• /Desktop/MGS-MultithreadedGameServer/Plugins/Games/ChatRoom.h
• /Desktop/MGS-MultithreadedGameServer/Plugins/Games/ChatRoom.cc

---