Consumer

Paket	mx.messaging
Klass	public class Consumer
Arv	Consumer AbstractConsumer MessageAgent EventDispatcher Object

Språkversion:

ActionScript 3.0

Produktversioner:

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

Körningsmiljöversioner:

Flash Player 9, AIR 1.1

A Consumer subscribes to a destination to receive messages. Consumers send subscribe and unsubscribe messages which generate a MessageAckEvent or MessageFaultEvent depending upon whether the operation was successful or not. Once subscribed, a Consumer dispatches a MessageEvent for each message it receives. Consumers provide the ability to filter messages using a selector. These selectors must be understood by the destination.

MXML-syntax expanded

Dölj MXML-syntax

The <mx:Consumer> tag inherits all the tag attributes of its superclass, and adds the following tag attributes:

   <mx:Consumer
    Properties
    resubscribeAttempts="5"
    resubscribeInterval="5000"
    selector="No default."
    timestamp="No default."
  />

Publika egenskaper

Dölj ärvda publika egenskaper

Visa ärvda publika egenskaper

	Egenskap		Definieras med
		authenticated : Boolean [skrivskyddad] 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 [skrivskyddad] Provides access to the client id for the MessageAgent.	MessageAgent
		connected : Boolean [skrivskyddad] Indicates whether this MessageAgent is currently connected to its destination via its ChannelSet.	MessageAgent
		constructor : Object En referens till klassobjektet eller konstruktorfunktionen för en given objektinstans.	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
		selector : String The selector for the Consumer.	Consumer
		subscribed : Boolean [skrivskyddad] Indicates whether the Consumer is currently subscribed.	AbstractConsumer
		subtopic : String Provides access to the subtopic for the remote destination that the MessageAgent uses.	Consumer
		timestamp : Number Contains the timestamp of the most recent message this Consumer has received.	AbstractConsumer

Skyddade egenskaper

Dölj ärvda skyddade egenskaper

Visa ärvda skyddade egenskaper

	Egenskap		Definieras med
		_shouldBeSubscribed : Boolean Flag indicating whether this consumer should be subscribed or not.	AbstractConsumer

Publika metoder

Dölj ärvda publika metoder

Visa ärvda publika metoder

	Metod		Definieras med
		Consumer(messageType:String = "flex.messaging.messages.AsyncMessage") Constructor.	Consumer
		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 Registrerar ett händelseavlyssnarobjekt för ett EventDispatcher-objekt så att avlyssnaren får meddelanden om händelser.	EventDispatcher
		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 [åsidosätt] Disconnects the Consumer from its remote destination.	AbstractConsumer
		dispatchEvent(event:Event):Boolean Skickar en händelse till händelseflödet.	EventDispatcher
		fault(errMsg:ErrorMessage, msg:IMessage):void Invoked by a MessageResponder upon receiving a fault for a sent message.	MessageAgent
		hasEventListener(type:String):Boolean Kontrollerar om EventDispatcher-objektet har några avlyssnare registrerade för en viss typ av händelse.	EventDispatcher
		hasOwnProperty(name:String):Boolean Anger om det finns en egenskap angiven för ett objekt.	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 Anger om en instans av klassen Object finns i prototypkedjan för objektet som anges som parameter.	Object
		logout():void Logs the MessageAgent out from its remote destination.	MessageAgent
		propertyIsEnumerable(name:String):Boolean Anger om den angivna egenskapen finns och är uppräkningsbar.	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 Tar bort en avlyssnare från EventDispatcher-objektet.	EventDispatcher
		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 Anger tillgänglighet för en dynamisk egenskap för slingåtgärder.	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 Returnerar det här objektets strängrepresentation, formaterad i enlighet med språkspecifika konventioner.	Object
		toString():String Returnerar det angivna objektets strängbeteckning.	Object
		unsubscribe(preserveDurable:Boolean = false):void Unsubscribes from the remote destination.	AbstractConsumer
		valueOf():Object Returnerar det angivna objektets primitiva värde.	Object
		willTrigger(type:String):Boolean Kontrollerar om en händelseavlyssnare är registrerad för det här EventDispatcher-objektet eller något av dess överordnade objekt för den angivna händelsetypen.	EventDispatcher

Skyddade metoder

Dölj ärvda skyddade metoder

Visa ärvda skyddade metoder

	Metod		Definieras med
		buildSubscribeMessage():CommandMessage Returns a subscribe message.	AbstractConsumer
		buildUnsubscribeMessage(preserveDurable:Boolean):CommandMessage Returns an unsubscribe message.	AbstractConsumer
		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

Händelser

Klicka för mer information om händelser

Dölj ärvda händelser

Visa ärvda händelser

	Sammanfattning	Definieras med
acknowledge	Dispatched when an acknowledge message is received for a sent message.	MessageAgent
activate	[utsändningshändelse] Skickas när Flash Player eller AIR får operativsystemfokus och blir aktivt.	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	[utsändningshändelse] Skickas när Flash Player eller AIR förlorar operativsystemfokus och blir inaktivt.	EventDispatcher
fault	Dispatched when a message fault occurs.	MessageAgent
message	Dispatched when a message is received by the Consumer.	Consumer
propertyChange	Dispatched when the connected property of the MessageAgent changes.	MessageAgent

Egenskapsdetaljer

selector

egenskap

selector:String

Språkversion:

ActionScript 3.0

Produktversioner:

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

Körningsmiljöversioner:

Flash Player 9, AIR 1.1

The selector for the Consumer. This is an expression that is passed to the destination which uses it to filter the messages delivered to the Consumer.

Before a call to the subscribe() method, this property can be set with no side effects. After the Consumer has subscribed to its destination, changing this value has the side effect of updating the Consumer's subscription to use the new selector expression immediately.

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

Den här egenskapen kan användas som källan för databindning. När den här egenskapen ändras, skickas händelsen propertyChange .

Implementering
public function get selector():String
public function set selector(value:String):void

subtopic

egenskap

subtopic:String

Språkversion:

ActionScript 3.0

Produktversioner:

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

Körningsmiljöversioner:

Flash Player 9, AIR 1.1

Provides access to the subtopic for the remote destination that the MessageAgent uses.

Den här egenskapen kan användas som källan för databindning. När den här egenskapen ändras, skickas händelsen propertyChange .

Implementering
public function get subtopic():String
public function set subtopic(value:String):void

Konstruktordetaljer

()

Konstruktor

public function Consumer(messageType:String = "flex.messaging.messages.AsyncMessage")

Språkversion:

ActionScript 3.0

Produktversioner:

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

Körningsmiljöversioner:

Flash Player 9, AIR 1.1

Constructor.

Parametrar

messageType:String (default = "flex.messaging.messages.AsyncMessage") — The alias for the message type processed by the service hosting the remote destination the Consumer will subscribe to. This parameter is deprecated and it is ignored by the constructor.

Exempel ( Så här använder du exemplet )

       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());
       }

Händelsedetaljer

message

Händelse

Typ av händelseobjekt: mx.messaging.events.MessageEvent
egenskap MessageEvent.type = mx.messaging.events.MessageEvent.MESSAGE

Språkversion:

ActionScript 3.0

Produktversioner:

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

Körningsmiljöversioner:

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.

Juridiska meddelanden | Onlinesekretesspolicy

Consumer - AS3 BlazeDS LCDS

Klasser x

selector

subtopic

Consumer

message