Class org.omus.msg.Messenger

Implemented Interfaces

iObservable

Description

Cette classe gère l'envoi, la réception et le filtrage des messages. Contrairement à Mail, elle ne gère que les messages non persistants tels ceux d'un chat. Un mécasnisme de publication/abonnement est inclus pour la distribution des messages.

Evénements auxquels s'abonner :

Cette classe est implémentée en suivant le modèle Singleton. Un accès global à son instance est obtenu grâce à la méthode getInstance. Elle est aggrémentée par composition des méthodes des sources d'événements (EventDispatcher).

See Also

Method Index

addFilter(), addListener(), countListeners(), getInstance(), getSubscriptions(), handleMessage(), isSubscribed(), publish(), removeAllListeners(), removeFilter(), removeListener(), sendToAll(), sendToGroup(), sendToServer(), sendToUser(), subscribe(), toLog(), toString(), unsubscribe(), unsubscribeAll()

Method Detail

toString

public function toString():String

Utilisé dans un contexte littéral

Return

Une chaine définissant l'objet

sendToUser

public function sendToUser(msg:Message, username:String, sameGroup:Boolean):Void

N'envoie un message qu'à un seul utilisateur.

Parameters

msgMessage à pfaire parvenir.
usernameNom de l'utilisateur.
sameGrouptrue si l'utilisateur doit obligatoirement appartenir au même groupe pour recevoir le message.

sendToGroup

public function sendToGroup(msg:Message, groupName:String):Void

Envoie un message à tous les membres d'un seul groupe.

Parameters

msgLe message à envoyer.
groupNameOptionnel. Le groupe devant recevoir le message. Si le nom du groupe n'est pas précisé, le groupe actuel reçoit le message.

sendToAll

public function sendToAll(msg:Message):Void

Envoie un message à tous les utilisateurs loogés au serveur.

Parameters

msgMessage à envoyer à tous.

sendToServer

public function sendToServer(msg:Message):Void

N'envoie un message qu'au serveur. Il est nécessaire de créer une extension pour recevoir ce message.

Parameters

msgMessage à envoyer au serveur.

publish

public function publish(msg:Message):Void

Publie un message à tous les membres abonnés au sujet.

Parameters

msgLe message à envoyer.

subscribe

public function subscribe(subject:String):Void

S'abonne à tous les messages du sujet spécifié. Génère un événement onSubscribe aux abonnés.

Parameters

subjectSujet du message auquel s'abonner.

unsubscribe

public function unsubscribe(subject:String):Void

Se désabonne à un sujet. Génère un événement onUnsubscribe aux abonnés.

Parameters

subjectSujet auquel se désabonner.

unsubscribeAll

public function unsubscribeAll()

Se désabonne de tous les messages. Génère un événement onUnsubscribeAll aux abonnés.

getSubscriptions

public function getSubscriptions():Array

Renvoie une liste de tous les sujets auquel le poste client s'est abonné.

Return

Une liste de tous les abonnements.

isSubscribed

public function isSubscribed(subject:String):Boolean

Renvoie si cet utilisateur a souscrit au sujet d'un message.

Parameters

subjectLe sujet souhaité.

Return

true si le client est abonné à ce sujet.

addFilter

public function addFilter(filter:MessageFilter):Void

Rajoute un filtre pour ne recevoir qu'une partie des messages.

Parameters

filterUn nouveau filtre.

removeFilter

public function removeFilter(filter:MessageFilter):Void

Supprime un filtre.

Parameters

filterLe filtre à supprimer.

addListener

public function addListener(listener:Object):Boolean

Ajoute un nouvel observateur.

Parameters

listenerRéférence de l'observateur.

Return

Un booléen indiquant la réussite de l'opération.

Specified By

addListener() in org.omus.util.iObservable

removeListener

public function removeListener(listener:Object):Boolean

Supprime un observateur.

Parameters

listenerRéférence de l'observateur.

Return

Un booléen indiquant la réussite de l'opération.

Specified By

removeListener() in org.omus.util.iObservable

removeAllListeners

public function removeAllListeners():Void

Supprime tous les abonnés.

Specified By

removeAllListeners() in org.omus.util.iObservable

countListeners

public function countListeners():Number

Retourne le nombre d'observateurs.

Return

Le nombre d'observateurs enregistrés.

Specified By

countListeners() in org.omus.util.iObservable

handleMessage

public function handleMessage(env:Envelope):Void

Gestionnaire d'accusé de réception de tout les messages serveur. Dirige le message vers le bon gestionnaire. TODO : Par l'air d'être utilisé ?! Voir si ce n'est pas un oubli d'implémenation de iMessageHandler.

Parameters

envEnveloppe renvoyée par le serveur.

toLog

static public function toLog():String

Utilisé dans un contexte littéral

Return

Une chaine définissant l'objet.

getInstance

static public function getInstance():Messenger

Accès global à la référence du Singleton

Return

Une référence à la classe