Package | mx.messaging |
Classe | public class AbstractConsumer |
Héritage | AbstractConsumer MessageAgent EventDispatcher Object |
Sous-classes | Consumer, MultiTopicConsumer |
Version du langage: | ActionScript 3.0 |
Versions du produit: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Propriété | Défini par | ||
---|---|---|---|
authenticated : Boolean [lecture seule]
Indique si cette classe MessageAgent utilise une connexion à sa destination authentifiée. | MessageAgent | ||
channelSet : ChannelSet
Fournit un accès à la classe ChannelSet utilisée par la classe MessageAgent. | MessageAgent | ||
clientId : String [lecture seule]
Fournit un accès à l’ID client pour la classe MessageAgent. | MessageAgent | ||
connected : Boolean [lecture seule]
Indique si cette classe MessageAgent est actuellement connectée à sa destination via sa classe ChannelSet. | MessageAgent | ||
constructor : Object
Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet. | Object | ||
destination : String
Fournit un accès à la destination pour la classe MessageAgent. | MessageAgent | ||
maxFrequency : uint
Détermine le nombre maximal de messages par seconde que la classe Consumer souhaite recevoir. | AbstractConsumer | ||
requestTimeout : int
Fournit un accès au délai d’attente de demande en secondes pour les messages envoyés. | MessageAgent | ||
resubscribeAttempts : int
Nombre de tentatives de réabonnement effectuées par la classe Consumer si la destination n’est pas disponible ou si la connexion à la destination est interrompue. | AbstractConsumer | ||
resubscribeInterval : int
Nombre de millisecondes s’écoulant entre les tentatives de réabonnement. | AbstractConsumer | ||
subscribed : Boolean [lecture seule]
Indique si la classe Consumer est actuellement abonnée. | AbstractConsumer | ||
timestamp : Number
Contient la date et l’heure du message le plus récent que cette classe Consumer a reçu. | AbstractConsumer |
Propriété | Défini par | ||
---|---|---|---|
_shouldBeSubscribed : Boolean
Indicateur spécifiant si cette classe Consumer doit être abonnée ou non. | AbstractConsumer |
Méthode | Défini par | ||
---|---|---|---|
Construit une classe Consumer. | AbstractConsumer | ||
Invoqué par une classe MessageResponder à la réception d’un résultat pour un message envoyé. | MessageAgent | ||
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Enregistre un objet écouteur d’événement auprès d’un objet EventDispatcher afin que l’écouteur soit averti d’un événement. | EventDispatcher | ||
Gère un événement ChannelEvent CONNECT. | MessageAgent | ||
Gère un événement ChannelEvent DISCONNECT. | MessageAgent | ||
Gère un événement ChannelFaultEvent. | MessageAgent | ||
[override]
Déconnecte la classe Consumer de sa destination distante. | AbstractConsumer | ||
Distribue un événement dans le flux d’événements. | EventDispatcher | ||
Invoqué par une classe MessageResponder à la réception d’une erreur pour un message envoyé. | MessageAgent | ||
Vérifie si des écouteurs sont enregistrés auprès de l’objet EventDispatcher pour un type spécifique d’événement. | EventDispatcher | ||
Indique si la propriété spécifiée d’un objet est définie. | Object | ||
Renvoie true si des demandes sont en attente pour le message transmis. | MessageAgent | ||
Appelé une fois que l’objet d’implémentation a été créé et que toutes les propriétés spécifiées sur la balise ont été affectées. | MessageAgent | ||
Indique si une occurrence de la classe Object figure dans la chaîne de prototype de l’objet spécifié en tant que paramètre. | Object | ||
Déconnecte la classe MessageAgent de sa destination distante. | MessageAgent | ||
Indique si la propriété spécifiée existe et est énumérable. | Object | ||
Demande les messages mis en file d’attente pour cette classe Consumer sur le serveur. | AbstractConsumer | ||
Supprime un écouteur de l’objet EventDispatcher. | EventDispatcher | ||
Définit les informations d’identification que la classe MessageAgent utilise pour s’authentifier auprès des destinations. | MessageAgent | ||
Définit la disponibilité d’une propriété dynamique pour les opérations en boucle. | Object | ||
Définit les informations d’identification distantes allant être transmises à la destination distante en vue de l’authentification auprès des systèmes secondaires. | MessageAgent | ||
S’abonne à la destination distante. | AbstractConsumer | ||
Renvoie la représentation de chaîne de cet objet, formatée selon les paramètres régionaux en vigueur. | Object | ||
Renvoie la représentation sous forme de chaîne de l’objet spécifié. | Object | ||
Se désabonne de la destination distante. | AbstractConsumer | ||
Renvoie la valeur primitive de l’objet spécifié. | Object | ||
Vérifie si un écouteur d’événement est enregistré auprès de cet objet EventDispatcher ou de ses ancêtres pour le type d’événement spécifié. | EventDispatcher |
Méthode | Défini par | ||
---|---|---|---|
Renvoie un message d’abonnement. | AbstractConsumer | ||
Renvoie un message de désabonnement. | AbstractConsumer | ||
Gère l’erreur d’authentification sur le serveur. | MessageAgent | ||
Permet d’initialiser automatiquement la propriété channelSet pour la classe MessageAgent avant qu’elle ne se connecte pour la première fois. | MessageAgent | ||
Envoie un message de la classe MessageAgent vers sa destination à l’aide de la classe ChannelSet de l’agent. | MessageAgent | ||
Cette fonction doit être remplacée par les sous-classes pour mettre en oeuvre la réauthentification résultant d’un comportement de dépassement de délai de session sur le serveur qui leur est spécifique. | MessageAgent |
Evénement | Synthèse | Défini par | ||
---|---|---|---|---|
Distribué lorsqu’un message d’accusé est reçu pour un message envoyé. | MessageAgent | |||
[Evénement de diffusion] Distribué lorsque l’application Flash Player obtient le focus du système d’exploitation et devient active. | EventDispatcher | |||
Distribué lorsque le canal sous-jacent de la classe MessageAgent utilise des connexions. | MessageAgent | |||
Distribué lorsque le canal sous-jacent de la classe MessageAgent utilise des déconnexions. | MessageAgent | |||
Distribué lorsque le canal sous-jacent utilisé par la classe MessageAgent génère des erreurs. | MessageAgent | |||
[Evénement de diffusion] Distribué lorsque l’application Flash Player ou AIR perd le focus du système d’exploitation et devient inactive. | EventDispatcher | |||
Distribué lorsqu’une erreur de message se produit. | MessageAgent | |||
Distribué lorsqu’un message est reçu par la classe Consumer. | AbstractConsumer | |||
Distribué lorsque la propriété connected de la classe MessageAgent change. | MessageAgent |
_shouldBeSubscribed | propriété |
protected var _shouldBeSubscribed:Boolean
Version du langage: | ActionScript 3.0 |
Versions du produit: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Indicateur spécifiant si cette classe Consumer doit être abonnée ou non.
maxFrequency | propriété |
maxFrequency:uint
Version du langage: | ActionScript 3.0 |
Versions du produit: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Détermine le nombre maximal de messages par seconde que la classe Consumer souhaite recevoir. Un serveur qui comprend cette valeur l’utilise comme entrée alors qu’il détermine la vitesse à laquelle envoyer des messages à la classe Consumer. La valeur par défaut est 0, ce qui signifie que la classe Consumer n’a aucune préférence quant au taux de messages. Cette propriété doit être définie avant que la classe Consumer ne s’abonne et les modifications effectuées après l’abonnement de la classe Consumer ne prennent effet que lorsque la classe Consumer se désabonne et se réabonne.
Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement propertyChange
.
Implémentation
public function get maxFrequency():uint
public function set maxFrequency(value:uint):void
resubscribeAttempts | propriété |
resubscribeAttempts:int
Version du langage: | ActionScript 3.0 |
Versions du produit: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Nombre de tentatives de réabonnement effectuées par la classe Consumer si la destination n’est pas disponible ou si la connexion à la destination est interrompue. Une valeur égale à -1 permet des tentatives illimitées. Une valeur égale à zéro désactive les tentatives de réabonnement.
Les tentatives de réabonnement sont effectuées à un rythme constant selon la valeur interne de réabonnement. Lorsqu’une tentative de réabonnement a lieu, si le canal sous-jacent de la classe Consumer n’est pas connecté ou ne tente pas de se connecter, le canal commence une tentative de connexion. Les tentatives de réabonnement suivantes de la classe Consumer qui se produisent alors que la tentative de connexion du canal sous-jacent est en attente sont ignorées jusqu’à ce que la tentative de connexion en attente du canal réussisse ou échoue.
Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement propertyChange
.
Implémentation
public function get resubscribeAttempts():int
public function set resubscribeAttempts(value:int):void
Eléments de l’API associés
resubscribeInterval | propriété |
resubscribeInterval:int
Version du langage: | ActionScript 3.0 |
Versions du produit: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Nombre de millisecondes s’écoulant entre les tentatives de réabonnement. Si une classe Consumer ne reçoit pas d’accusé pour une demande d’abonnement, elle attend pendant le nombre de millisecondes spécifié avant d’essayer de se réabonner. Définir la valeur sur zéro désactive les réabonnements.
Les tentatives de réabonnement sont effectuées à un rythme constant selon cette valeur. Lorsqu’une tentative de réabonnement a lieu, si le canal sous-jacent de la classe Consumer n’est pas connecté ou ne tente pas de se connecter, le canal commence une tentative de connexion. Les tentatives de réabonnement suivantes de la classe Consumer qui se produisent alors que la tentative de connexion du canal sous-jacent est en attente sont ignorées jusqu’à ce que la tentative de connexion en attente du canal réussisse ou échoue.
Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement propertyChange
.
Implémentation
public function get resubscribeInterval():int
public function set resubscribeInterval(value:int):void
Valeur émise
ArgumentError — Si la valeur assignée est négative.
|
Eléments de l’API associés
subscribed | propriété |
subscribed:Boolean
[lecture seule] Version du langage: | ActionScript 3.0 |
Versions du produit: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Indique si la classe Consumer est actuellement abonnée. L’événement propertyChange
est distribué lorsque cette propriété change.
Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement propertyChange
.
Implémentation
public function get subscribed():Boolean
timestamp | propriété |
timestamp:Number
Version du langage: | ActionScript 3.0 |
Versions du produit: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Contient la date et l’heure du message le plus récent que cette classe Consumer a reçu. Cette valeur est transmise à la destination dans un appel receive()
afin de demander qu’il livre les messages pour la classe Consumer à partir de la date et de l’heure spécifiées. Tous les messages comportant une valeur de date et d’heure supérieure à la valeur timestamp
sont renvoyés durant une opération d’interrogation. Définir cette valeur sur -1 extrait tous les messages mis en cache de la destination.
Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement propertyChange
.
Implémentation
public function get timestamp():Number
public function set timestamp(value:Number):void
AbstractConsumer | () | Constructeur |
public function AbstractConsumer()
Version du langage: | ActionScript 3.0 |
Versions du produit: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Construit une classe Consumer.
Exemple ( Comment utiliser cet exemple )
function initConsumer():void { var consumer:Consumer = new Consumer(); consumer.destination = "NASDAQ"; consumer.selector = "operation IN ('Bid','Ask')"; consumer.addEventListener(MessageEvent.MESSAGE, messageHandler); consumer.subscribe(); } function messageHandler(event:MessageEvent):void { var msg:IMessage = event.message; var info:Object = msg.body; trace("-App recieved message: " + msg.toString()); }
buildSubscribeMessage | () | méthode |
protected function buildSubscribeMessage():CommandMessage
Version du langage: | ActionScript 3.0 |
Versions du produit: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Renvoie un message d’abonnement. Cette méthode doit être remplacée par des sous-classes si celles-ci nécessitent des messages d’abonnement personnalisés.
Valeur renvoyéeCommandMessage — Classe CommandMessage d’abonnement.
|
buildUnsubscribeMessage | () | méthode |
protected function buildUnsubscribeMessage(preserveDurable:Boolean):CommandMessage
Version du langage: | ActionScript 3.0 |
Versions du produit: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Renvoie un message de désabonnement. Cette méthode doit être remplacée par des sous-classes si celles-ci nécessitent des messages de désabonnement personnalisés.
Paramètres
preserveDurable:Boolean — - Si true, les abonnements JMS durables ne sont pas supprimés, ce qui permet aux classes Consumer de se réabonner et de recevoir par la suite les messages manqués.
|
CommandMessage — Classe CommandMessage de désabonnement.
|
disconnect | () | méthode |
override public function disconnect():void
Version du langage: | ActionScript 3.0 |
Versions du produit: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Déconnecte la classe Consumer de sa destination distante. Cette méthode doit être invoquée sur une classe Consumer dont une application n’a plus besoin après désabonnement. Cette méthode n’attend pas que les opérations de réseau en attente se terminent et n’envoie pas de message de désabonnement au serveur. Après avoir invoqué la méthode disconnect(), la classe Consumer signale qu’elle est dans un état déconnecté et non abonné car elle ne reçoit plus de messages tant qu’elle ne se reconnecte pas et ne se réabonne pas. La déconnexion arrête les tentatives de réabonnement automatiques si elles sont en cours d’exécution.
receive | () | méthode |
public function receive(timestamp:Number = 0):void
Version du langage: | ActionScript 3.0 |
Versions du produit: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Demande les messages mis en file d’attente pour cette classe Consumer sur le serveur. Cette méthode ne doit être utilisée que pour les classes Consumer qui s’abonnent via des canaux qui ne sont pas en temps réel et qui n’interrogent pas. Cette méthode est non opératoire lorsque la classe Consumer n’est pas abonnée.
Paramètres
timestamp:Number (default = 0 ) — Cet argument est déconseillé et est ignoré.
|
subscribe | () | méthode |
public function subscribe(clientId:String = null):void
Version du langage: | ActionScript 3.0 |
Versions du produit: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
S’abonne à la destination distante.
Paramètres
clientId:String (default = null ) — ID client avec lequel s’abonner. Utilisez null pour les classes Consumer temporaires. Si l’abonnement est durable, une valeur cohérente doit être fournie chaque fois que la classe Consumer s’abonne pour se reconnecter à l’abonnement durable correct au niveau de la destination distante.
|
Valeur émise
InvalidDestinationError — Si aucune destination n’est définie.
|
unsubscribe | () | méthode |
public function unsubscribe(preserveDurable:Boolean = false):void
Version du langage: | ActionScript 3.0 |
Versions du produit: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Se désabonne de la destination distante. Dans le cas d’abonnements JMS durables, ceci supprime l’abonnement durable sur le serveur JMS.
Paramètres
preserveDurable:Boolean (default = false ) — - Si true, les abonnements JMS durables ne sont pas supprimés, ce qui permet aux classes Consumer de se réabonner et de recevoir par la suite les messages manqués.
|
message | Evénement |
mx.messaging.events.MessageEvent
propriété MessageEvent.type =
mx.messaging.events.MessageEvent.MESSAGE
Version du langage: | ActionScript 3.0 |
Versions du produit: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Distribué lorsqu’un message est reçu par la classe Consumer.
Type d’événement MESSAGE ; distribué à la réception d’un message.La valeur de cette constante est "message"
.
Les valeurs des propriétés de l’objet d’événement sont les suivantes :
Propriété | Valeur |
---|---|
bubbles | false |
cancelable | false |
currentTarget | Objet définissant l’écouteur d’événement qui traite l’événement. Par exemple, si vous utilisez myButton.addEventListener() pour enregistrer un écouteur d’événement, myButton est la valeur de currentTarget . |
message | Message associé à cet événement. |
target | Objet qui a distribué l’événement (il ne s’agit pas toujours de l’objet qui écoute l’événement). Pour accéder systématiquement à l’objet qui écoute l’événement, utilisez la propriété currentTarget . |
Tue Jun 12 2018, 09:30 AM Z