AbstractConsumer

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

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 AbstractConsumer is the base class for both the Consumer and MultiTopicConsumer classes. You use those classes to receive pushed messages from the server.

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
		subscribed : Boolean [skrivskyddad] Indicates whether the Consumer is currently subscribed.	AbstractConsumer
		timestamp : Number Contains the timestamp of the most recent message this Consumer has received.	AbstractConsumer

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
		AbstractConsumer() Constructs a Consumer.	AbstractConsumer
		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.	AbstractConsumer
propertyChange	Dispatched when the connected property of the MessageAgent changes.	MessageAgent

Egenskapsdetaljer

_shouldBeSubscribed

egenskap

protected var _shouldBeSubscribed:Boolean

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

Flag indicating whether this consumer should be subscribed or not.

maxFrequency

egenskap

maxFrequency:uint

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

Determines the maximum number of messages per second the Consumer wants to receive. A server that understands this value will use it as an input while it determines how fast to send messages to the Consumer. Default is 0 which means Consumer does not have a preference for the message rate. Note that this property should be set before the Consumer subscribes and any changes after Consumer subscription will not have any effect until Consumer unsubscribes and resubscribes.

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 maxFrequency():uint
public function set maxFrequency(value:uint):void

resubscribeAttempts

egenskap

resubscribeAttempts:int

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 number of resubscribe attempts that the Consumer makes in the event that the destination is unavailable or the connection to the destination fails. A value of -1 enables infinite attempts. A value of zero disables resubscribe attempts.

Resubscribe attempts are made at a constant rate according to the resubscribe interval value. When a resubscribe attempt is made if the underlying channel for the Consumer is not connected or attempting to connect the channel will start a connect attempt. Subsequent Consumer resubscribe attempts that occur while the underlying channel connect attempt is outstanding are effectively ignored until the outstanding channel connect attempt succeeds or fails.

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 resubscribeAttempts():int
public function set resubscribeAttempts(value:int):void

Relaterade API-element

mx.messaging.Consumer.resubscribeInterval

resubscribeInterval

egenskap

resubscribeInterval:int

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 number of milliseconds between resubscribe attempts. If a Consumer doesn't receive an acknowledgement for a subscription request, it will wait the specified number of milliseconds before attempting to resubscribe. Setting the value to zero disables resubscriptions.

Resubscribe attempts are made at a constant rate according to this value. When a resubscribe attempt is made if the underlying channel for the Consumer is not connected or attempting to connect the channel will start a connect attempt. Subsequent Consumer resubscribe attempts that occur while the underlying channel connect attempt is outstanding are effectively ignored until the outstanding channel connect attempt succeeds or fails.

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 resubscribeInterval():int
public function set resubscribeInterval(value:int):void

Utlöser

ArgumentError — If the assigned value is negative.

Relaterade API-element

mx.messaging.Consumer.resubscribeInterval

subscribed

egenskap

subscribed:Boolean [skrivskyddad]

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

Indicates whether the Consumer is currently subscribed. The propertyChange event is dispatched when this property changes.

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 subscribed():Boolean

timestamp

egenskap

timestamp:Number

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

Contains the timestamp of the most recent message this Consumer has received. This value is passed to the destination in a receive() call to request that it deliver messages for the Consumer from the timestamp forward. All messages with a timestamp value greater than the timestamp value will be returned during a poll operation. Setting this value to -1 will retrieve all cached messages from the destination.

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 timestamp():Number
public function set timestamp(value:Number):void

Konstruktordetaljer

()

Konstruktor

public function AbstractConsumer()

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

Constructs a Consumer.

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

Metoddetaljer

buildSubscribeMessage

()

metod

protected function buildSubscribeMessage():CommandMessage

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

Returns a subscribe message. This method should be overridden by subclasses if they need custom subscribe messages.

Returnerar

CommandMessage — The subscribe CommandMessage.

buildUnsubscribeMessage

()

metod

protected function buildUnsubscribeMessage(preserveDurable:Boolean):CommandMessage

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

Returns an unsubscribe message. This method should be overridden by subclasses if they need custom unsubscribe messages.

Parametrar

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

Returnerar

CommandMessage — The unsubscribe CommandMessage.

disconnect

()

metod

override public function disconnect():void

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

Disconnects the Consumer from its remote destination. This method should be invoked on a Consumer that is no longer needed by an application after unsubscribing. This method does not wait for outstanding network operations to complete and does not send an unsubscribe message to the server. After invoking disconnect(), the Consumer will report that it is in an disconnected, unsubscribed state because it will not receive any more messages until it has reconnected and resubscribed. Disconnecting stops automatic resubscription attempts if they are running.

receive

()

metod

public function receive(timestamp:Number = 0):void

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

Requests any messages that are queued for this Consumer on the server. This method should only be used for Consumers that subscribe over non-realtime, non-polling channels. This method is a no-op if the Consumer is not subscribed.

Parametrar

timestamp:Number (default = 0) — This argument is deprecated and is ignored.

()

metod

public function subscribe(clientId:String = null):void

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

Subscribes to the remote destination.

Parametrar

clientId:String (default = null) — The client id to subscribe with. Use null for non-durable Consumers. If the subscription is durable, a consistent value must be supplied every time the Consumer subscribes in order to reconnect to the correct durable subscription in the remote destination.

Utlöser

InvalidDestinationError — If no destination is set.

unsubscribe

()

metod

public function unsubscribe(preserveDurable:Boolean = false):void

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

Unsubscribes from the remote destination. In the case of durable JMS subscriptions, this will destroy the durable subscription on the JMS server.

Parametrar

preserveDurable:Boolean (default = false) — - when true, durable JMS subscriptions are not destroyed allowing consumers to later resubscribe and receive missed messages

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

AbstractConsumer - AS3 BlazeDS LCDS

Klasser x

_shouldBeSubscribed

maxFrequency

resubscribeAttempts

resubscribeInterval

subscribed

timestamp