MultiTopicConsumer

Pakket	mx.messaging
Klasse	public class MultiTopicConsumer
Overerving	MultiTopicConsumer AbstractConsumer MessageAgent EventDispatcher Object

Taalversie:

ActionScript 3.0

Productversies:

BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3

Runtimeversies:

Flash Player 9, AIR 1.1

Like a Consumer, a MultiTopicConsumer subscribes to a destination with a single clientId and delivers messages to a single event handler. Unlike a Consumer it lets you register subscriptions for a list of subtopics and selector expressions at the same time from a single message handler. Where Consumer has subtopic and selector properties, this component has an addSubscription(subtopic, selector) method you use to add a new subscription to the existing set of subscriptions. Alternatively, you can populate the subscriptions property with a list of SubscriptionInfo instances that define the subscriptions for this destination.

Like the regular Consumer, the MultiTopicConsumer sends subscribe and unsubscribe messages which generate a MessageAckEvent or MessageFaultEvent depending upon whether the operation was successful or not. Once subscribed, a MultiTopicConsumer dispatches a MessageEvent for each message it receives.

MXML-syntaxis expanded

MXML-syntaxis verbergen

The <mx:MultiTopicConsumer> tag has these properties:

       <mx:Consumer
        Properties
        subscriptions=""an empty ArrayCollection of SubscriptionInfo objects"
        resubscribeAttempts="5"
        resubscribeInterval="5000"
        timestamp="No default."
      />

Openbare eigenschappen

Overerfde openbare eigenschappen verbergen

Overerfde openbare eigenschappen weergeven

	Eigenschap		Gedefinieerd door
		authenticated : Boolean [alleen-lezen] Indicates if this MessageAgent is using an authenticated connection to its destination.	MessageAgent
		channelSet : ChannelSet Provides access to the ChannelSet used by the MessageAgent.	MessageAgent
		clientId : String [alleen-lezen] Provides access to the client id for the MessageAgent.	MessageAgent
		connected : Boolean [alleen-lezen] Indicates whether this MessageAgent is currently connected to its destination via its ChannelSet.	MessageAgent
		constructor : Object Verwijzing naar het klasseobject of de constructorfunctie van een bepaalde objectinstantie.	Object
		destination : String Provides access to the destination for the MessageAgent.	MessageAgent
		maxFrequency : uint Determines the maximum number of messages per second the Consumer wants to receive.	AbstractConsumer
		requestTimeout : int Provides access to the request timeout in seconds for sent messages.	MessageAgent
		resubscribeAttempts : int The number of resubscribe attempts that the Consumer makes in the event that the destination is unavailable or the connection to the destination fails.	AbstractConsumer
		resubscribeInterval : int The number of milliseconds between resubscribe attempts.	AbstractConsumer
		subscribed : Boolean [alleen-lezen] Indicates whether the Consumer is currently subscribed.	AbstractConsumer
		subscriptions : ArrayCollection Stores an Array of SubscriptionInfo objects.	MultiTopicConsumer
		timestamp : Number Contains the timestamp of the most recent message this Consumer has received.	AbstractConsumer

Beschermde eigenschappen

Overerfde beschermde eigenschappen verbergen

Overerfde beschermde eigenschappen weergeven

	Eigenschap		Gedefinieerd door
		_shouldBeSubscribed : Boolean Flag indicating whether this consumer should be subscribed or not.	AbstractConsumer

Openbare methoden

Overerfde openbare methoden verbergen

Overerfde openbare methoden weergeven

	Methode		Gedefinieerd door
		MultiTopicConsumer() Constructor.	MultiTopicConsumer
		acknowledge(ackMsg:AcknowledgeMessage, msg:IMessage):void Invoked by a MessageResponder upon receiving a result for a sent message.	MessageAgent
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registreert een gebeurtenislistenerobject bij een object EventDispatcher, zodat de listener een melding van een gebeurtenis ontvangt.	EventDispatcher
		addSubscription(subtopic:String = null, selector:String = null, maxFrequency:uint = 0):void This is a convenience method for adding a new subscription.	MultiTopicConsumer
		channelConnectHandler(event:ChannelEvent):void Handles a CONNECT ChannelEvent.	MessageAgent
		channelDisconnectHandler(event:ChannelEvent):void Handles a DISCONNECT ChannelEvent.	MessageAgent
		channelFaultHandler(event:ChannelFaultEvent):void Handles a ChannelFaultEvent.	MessageAgent
		disconnect():void [overschrijven] Disconnects the Consumer from its remote destination.	AbstractConsumer
		dispatchEvent(event:Event):Boolean Verzendt een gebeurtenis naar de gebeurtenisstroom.	EventDispatcher
		fault(errMsg:ErrorMessage, msg:IMessage):void Invoked by a MessageResponder upon receiving a fault for a sent message.	MessageAgent
		hasEventListener(type:String):Boolean Controleert of het object EventDispatcher listeners heeft geregistreerd voor een specifiek type gebeurtenis.	EventDispatcher
		hasOwnProperty(name:String):Boolean Geeft aan of voor een object een opgegeven eigenschap is gedefinieerd.	Object
		hasPendingRequestForMessage(msg:IMessage):Boolean Returns true if there are any pending requests for the passed in message.	MessageAgent
		initialized(document:Object, id:String):void Called after the implementing object has been created and all properties specified on the tag have been assigned.	MessageAgent
		isPrototypeOf(theClass:Object):Boolean Geeft aan of een instantie van de klasse Object zich in de prototypeketen van het object bevindt dat als parameter is opgegeven.	Object
		logout():void Logs the MessageAgent out from its remote destination.	MessageAgent
		propertyIsEnumerable(name:String):Boolean Geeft aan of de opgegeven eigenschap bestaat en kan worden opgesomd.	Object
		receive(timestamp:Number = 0):void Requests any messages that are queued for this Consumer on the server.	AbstractConsumer
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Verwijdert een listener uit het object EventDispatcher.	EventDispatcher
		removeSubscription(subtopic:String = null, selector:String = null):void This method removes the subscription specified by the subtopic and selector.	MultiTopicConsumer
		setCredentials(username:String, password:String, charset:String = null):void Sets the credentials that the MessageAgent uses to authenticate to destinations.	MessageAgent
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Stelt de beschikbaarheid van een dynamische eigenschap voor lusbewerkingen in.	Object
		setRemoteCredentials(username:String, password:String, charset:String = null):void Sets the remote credentials that will be passed through to the remote destination for authenticating to secondary systems.	MessageAgent
		subscribe(clientId:String = null):void Subscribes to the remote destination.	AbstractConsumer
		toLocaleString():String Geeft de tekenreeksweergave van dit object weer, geformatteerd volgens de locatiespecifieke conventies.	Object
		toString():String Retourneert een tekenreeksrepresentatie van het opgegeven object.	Object
		unsubscribe(preserveDurable:Boolean = false):void Unsubscribes from the remote destination.	AbstractConsumer
		valueOf():Object Retourneert de primitieve waarde van het opgegeven object.	Object
		willTrigger(type:String):Boolean Controleert of een gebeurtenislistener is geregistreerd bij dit object EventDispatcher of een van de voorouders voor het opgegeven type gebeurtenis.	EventDispatcher

Beschermde methoden

Overerfde beschermde methoden verbergen

Overerfde beschermde methoden weergeven

	Methode		Gedefinieerd door
		buildSubscribeMessage():CommandMessage [overschrijven] Returns a subscribe message.	MultiTopicConsumer
		buildUnsubscribeMessage(preserveDurable:Boolean):CommandMessage [overschrijven] Returns an unsubscribe mesage.	MultiTopicConsumer
		handleAuthenticationFault(errMsg:ErrorMessage, msg:IMessage):void Handles the authentication fault on the server.	MessageAgent
		initChannelSet(message:IMessage):void Used to automatically initialize the channelSet property for the MessageAgent before it connects for the first time.	MessageAgent
		internalSend(message:IMessage, waitForClientId:Boolean = true):void Sends a Message from the MessageAgent to its destination using the agent's ChannelSet.	MessageAgent
		reAuthorize(msg:IMessage):void This function should be overriden by sublasses to implement reauthentication due to server session time-out behavior specific to them.	MessageAgent

Gebeurtenissen

Klik voor meer informatie over gebeurtenissen.

Overerfde gebeurtenissen verbergen

Overerfde gebeurtenissen weergeven

	Overzicht	Gedefinieerd door
acknowledge	Dispatched when an acknowledge message is received for a sent message.	MessageAgent
activate	[uitgezonden gebeurtenis] Wordt verzonden wanneer Flash Player of de AIR-toepassing de besturingssysteemfocus krijgt en actief wordt.	EventDispatcher
channelConnect	Dispatched when the underlying Channel the MessageAgent is using connects.	MessageAgent
channelDisconnect	Dispatched when the underlying Channel the MessageAgent is using disconnects.	MessageAgent
channelFault	Dispatched when the underlying Channel the MessageAgent is using faults.	MessageAgent
deactivate	[uitgezonden gebeurtenis] Wordt verzonden wanneer Flash Player of de AIR-toepassing de systeemfocus verliest en inactief wordt.	EventDispatcher
fault	Dispatched when a message fault occurs.	MessageAgent
message	Dispatched when a message is received by the Consumer.	MultiTopicConsumer
propertyChange	Dispatched when the connected property of the MessageAgent changes.	MessageAgent

Eigenschapdetails

subscriptions

eigenschap

subscriptions:ArrayCollection

Taalversie:

ActionScript 3.0

Productversies:

BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3

Runtimeversies:

Flash Player 9, AIR 1.1

Stores an Array of SubscriptionInfo objects. Each subscription contains a subtopic and a selector each of which can be null. A subscription with a non-null subtopic restricts the subscription to messages delivered with only that subtopic. If a subtopic is null, it uses the selector with no subtopic. If the selector and the subtopic is null, the subscription receives any messages targeted at the destination with no subtopic. The subtopic can contain a wildcard specification.

Before a call to the subscribe() method, this property can be set with no side effects. After the MultiTopicConsumer has subscribed to its destination, changing this value has the side effect of updating the MultiTopicConsumer's subscription to include any new subscriptions and remove any subscriptions you deleted from the ArrayCollection.

The remote destination must understand the value of the selector expression.

Deze eigenschap kan als de bron voor gegevensbinding worden gebruikt. Wanneer deze eigenschap wordt gewijzigd, wordt de gebeurtenis propertyChange verzonden.

Implementatie
public function get subscriptions():ArrayCollection
public function set subscriptions(value:ArrayCollection):void

Constructordetails

()

Constructor

public function MultiTopicConsumer()

Taalversie:

ActionScript 3.0

Productversies:

BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3

Runtimeversies:

Flash Player 9, AIR 1.1

Constructor.

Voorbeeld ( Hoe dit voorbeeld te gebruiken )

           function initConsumer():void
           {
               var consumer:Consumer = new MultiTopicConsumer();
               consumer.destination = "NASDAQ";
               consumer.addEventListener(MessageEvent.MESSAGE, messageHandler);
               consumer.addSubscription("myStock1", "operation IN ('BID', 'Ask')");
               consumer.addSubscription("myStock2", "operation IN ('BID', 'Ask')");
               consumer.subscribe();
           }
         
           function messageHandler(event:MessageEvent):void
           {
               var msg:IMessage = event.message;
               var info:Object = msg.body;
               trace("-App recieved message: " + msg.toString());
           }

Methodedetails

addSubscription

()

methode

public function addSubscription(subtopic:String = null, selector:String = null, maxFrequency:uint = 0):void

Taalversie:

ActionScript 3.0

Productversies:

BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3

Runtimeversies:

Flash Player 9, AIR 1.1

This is a convenience method for adding a new subscription. It just creates a new SubscriptionInfo object and adds it to the subscriptions property. To call this method, you provide the subtopic and selector string for the new subscription. If the subtopic is null, the subscription applies to messages which do not have a subtopic set in the producer. If the selector string is null, all messages sent which match the subtopic string are received by this consumer.

Parameters

	`subtopic:String` (default = `null`) — The subtopic for the new subscription.

	`selector:String` (default = `null`) — The selector for the new subscription.

	`maxFrequency:uint` (default = `0`) — The maximum number of messages per second the Consumer wants to receive for the subscription. Note that this value overwrites the Consumer wide maxFrequency.

buildSubscribeMessage

()

methode

override protected function buildSubscribeMessage():CommandMessage

Taalversie:

ActionScript 3.0

Productversies:

BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3

Runtimeversies:

Flash Player 9, AIR 1.1

Returns a subscribe message.

Geretourneerde waarde

CommandMessage — The subscribe CommandMessage.

buildUnsubscribeMessage

()

methode

override protected function buildUnsubscribeMessage(preserveDurable:Boolean):CommandMessage

Taalversie:

ActionScript 3.0

Productversies:

BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3

Runtimeversies:

Flash Player 9, AIR 1.1

Returns an unsubscribe mesage.

Parameters

preserveDurable:Boolean — When true, durable JMS subscriptions are not destroyed, allowing consumers to later resubscribe and receive missed messages.

Geretourneerde waarde

CommandMessage — The unsubscribe CommandMessage.

removeSubscription

()

methode

public function removeSubscription(subtopic:String = null, selector:String = null):void

Taalversie:

ActionScript 3.0

Productversies:

BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3

Runtimeversies:

Flash Player 9, AIR 1.1

This method removes the subscription specified by the subtopic and selector.

Parameters

	`subtopic:String` (default = `null`) — The subtopic for the subscription.

	`selector:String` (default = `null`) — The selector for the subscription.

Gebeurtenisdetails

message

Gebeurtenis

Type gebeurtenisobject: mx.messaging.events.MessageEvent
eigenschap MessageEvent.type = mx.messaging.events.MessageEvent.MESSAGE

Taalversie:

ActionScript 3.0

Productversies:

BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3

Runtimeversies:

Flash Player 9, AIR 1.1

Dispatched when a message is received by the Consumer.

The MESSAGE event type; dispatched upon receipt of a message.

The value of this constant is "message".

The properties of the event object have the following values:

Property	Value
`bubbles`	false
`cancelable`	false
`currentTarget`	The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`message`	The message associated with this event.
`target`	The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.

Juridische kennisgeving | Online privacybeleid

MultiTopicConsumer - AS3 BlazeDS LCDS

Klassen x

subscriptions