| Pakiet | mx.messaging |
| Klasa | public class AbstractConsumer |
| Dziedziczenie | AbstractConsumer  MessageAgent EventDispatcher Object |
| Podklasy | Consumer, MultiTopicConsumer |
| Wersja języka: | ActionScript 3.0 |
| Wersje produktu: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Wersje środowiska wykonawczego: | Flash Player 9, AIR 1.1 |
Ukryj dziedziczone właściwości publiczne
Pokaż dziedziczone właściwości publiczne| Właściwość | Zdefiniowane przez | ||
|---|---|---|---|
 | authenticated : Boolean [tylko do odczytu]
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 [tylko do odczytu]
Provides access to the client id for the MessageAgent. | MessageAgent | |
| connected : Boolean [tylko do odczytu]
Indicates whether this MessageAgent is currently connected to its
destination via its ChannelSet. | MessageAgent | |
| constructor : Object
Odwołanie do obiektu klasy lub funkcji konstruktora, dotyczące danej instancji obiektu. | 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 [tylko do odczytu]
Indicates whether the Consumer is currently subscribed. | AbstractConsumer | ||
| timestamp : Number
Contains the timestamp of the most recent message this Consumer
has received. | AbstractConsumer | ||
| Właściwość | Zdefiniowane przez | ||
|---|---|---|---|
| _shouldBeSubscribed : Boolean
Flag indicating whether this consumer should be subscribed or not. | AbstractConsumer | ||
| Metoda | Zdefiniowane przez | ||
|---|---|---|---|
Constructs a Consumer. | AbstractConsumer | ||
|
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
Rejestruje obiekt detektora zdarzeń w obiekcie EventDispatcher, dzięki czemu detektor będzie otrzymywał powiadomienia o zdarzeniu. | EventDispatcher | |
|
Handles a CONNECT ChannelEvent. | MessageAgent | |
|
Handles a DISCONNECT ChannelEvent. | MessageAgent | |
|
Handles a ChannelFaultEvent. | MessageAgent | |
[przesłanianie]
Disconnects the Consumer from its remote destination. | AbstractConsumer | ||
|
Wywołuje zdarzenie, tj. kieruje je do przepływu zdarzeń. | EventDispatcher | |
|
Invoked by a MessageResponder upon receiving a fault for a sent message. | MessageAgent | |
|
Sprawdza, czy obiekt EventDispatcher zawiera jakiekolwiek detektory zarejestrowane dla konkretnego typu zdarzeń. | EventDispatcher | |
|
Wskazuje, czy dla obiektu zdefiniowano określoną właściwość. | Object | |
|
Returns true if there are any pending requests for the passed in message. | MessageAgent | |
|
Called after the implementing object has been created
and all properties specified on the tag have been assigned. | MessageAgent | |
|
Wskazuje, czy instancja klasy Object należy do łańcucha prototypów obiektu określonego jako parametr. | Object | |
|
Logs the MessageAgent out from its remote destination. | MessageAgent | |
|
Wskazuje, czy określona właściwość istnieje i jest przeliczalna. | Object | |
Requests any messages that are queued for this Consumer on the server. | AbstractConsumer | ||
|
Usuwa detektor z obiektu EventDispatcher. | EventDispatcher | |
|
Sets the credentials that the MessageAgent uses to authenticate to
destinations. | MessageAgent | |
|
Ustawia dostępność właściwości dynamicznej używanej w pętlach. | Object | |
|
Sets the remote credentials that will be passed through to the remote destination
for authenticating to secondary systems. | MessageAgent | |
Subscribes to the remote destination. | AbstractConsumer | ||
|
Zwraca ciąg reprezentujący obiekt — sformatowany zgodnie z konwencjami właściwymi dla ustawień regionalnych. | Object | |
|
Zwraca ciąg reprezentujący określony obiekt. | Object | |
Unsubscribes from the remote destination. | AbstractConsumer | ||
|
Zwraca pierwotną wartość dla określonego obiektu. | Object | |
|
Sprawdza, czy detektor zdarzeń określonego typu jest zarejestrowany w tym obiekcie EventDispatcher lub jego elementach macierzystych. | EventDispatcher | |
| Metoda | Zdefiniowane przez | ||
|---|---|---|---|
Returns a subscribe message. | AbstractConsumer | ||
Returns an unsubscribe message. | AbstractConsumer | ||
|
Handles the authentication fault on the server. | MessageAgent | |
|
Used to automatically initialize the channelSet property for the
MessageAgent before it connects for the first time. | MessageAgent | |
|
Sends a Message from the MessageAgent to its destination using the
agent's ChannelSet. | MessageAgent | |
|
This function should be overriden by sublasses to implement reauthentication due to
server session time-out behavior specific to them. | MessageAgent | |
| Zdarzenie | Podsumowanie | Zdefiniowane przez | ||
|---|---|---|---|---|
| Dispatched when an acknowledge message is received for a sent message. | MessageAgent | ||
| [zdarzenie broadcast] Wywoływane, gdy program Flash Player lub aplikacja środowiska wykonawczego AIR uzyskuje fokus w systemie operacyjnym i przechodzi w stan aktywny. | EventDispatcher | ||
| Dispatched when the underlying Channel the MessageAgent is using connects. | MessageAgent | ||
| Dispatched when the underlying Channel the MessageAgent is using disconnects. | MessageAgent | ||
| Dispatched when the underlying Channel the MessageAgent is using faults. | MessageAgent | ||
| [zdarzenie broadcast] Wywoływane, gdy program Flash Player lub aplikacja AIR traci fokus w systemie operacyjnym i przechodzi w stan nieaktywny. | EventDispatcher | ||
| Dispatched when a message fault occurs. | MessageAgent | ||
| Dispatched when a message is received by the Consumer. | AbstractConsumer | |||
| Dispatched when the connected property of the MessageAgent changes. | MessageAgent | ||
_shouldBeSubscribed | właściwość |
protected var _shouldBeSubscribed:Boolean| Wersja języka: | ActionScript 3.0 |
| Wersje produktu: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Wersje środowiska wykonawczego: | Flash Player 9, AIR 1.1 |
Flag indicating whether this consumer should be subscribed or not.
maxFrequency | właściwość |
maxFrequency:uint| Wersja języka: | ActionScript 3.0 |
| Wersje produktu: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Wersje środowiska wykonawczego: | 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.
Ta właściwość może być używana jako źródło dla tworzenia powiązań danych. Jeśli ta właściwość zostanie zmodyfikowana, zostanie wywołane zdarzenie propertyChange .
Implementacja
public function get maxFrequency():uint public function set maxFrequency(value:uint):voidresubscribeAttempts | właściwość |
resubscribeAttempts:int| Wersja języka: | ActionScript 3.0 |
| Wersje produktu: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Wersje środowiska wykonawczego: | 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.
Ta właściwość może być używana jako źródło dla tworzenia powiązań danych. Jeśli ta właściwość zostanie zmodyfikowana, zostanie wywołane zdarzenie propertyChange .
Implementacja
public function get resubscribeAttempts():int public function set resubscribeAttempts(value:int):voidPowiązane elementy interfejsu API
resubscribeInterval | właściwość |
resubscribeInterval:int| Wersja języka: | ActionScript 3.0 |
| Wersje produktu: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Wersje środowiska wykonawczego: | 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.
Ta właściwość może być używana jako źródło dla tworzenia powiązań danych. Jeśli ta właściwość zostanie zmodyfikowana, zostanie wywołane zdarzenie propertyChange .
Implementacja
public function get resubscribeInterval():int public function set resubscribeInterval(value:int):voidZgłasza
ArgumentError — If the assigned value is negative.
|
Powiązane elementy interfejsu API
subscribed | właściwość |
subscribed:Boolean [tylko do odczytu] | Wersja języka: | ActionScript 3.0 |
| Wersje produktu: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Wersje środowiska wykonawczego: | Flash Player 9, AIR 1.1 |
Indicates whether the Consumer is currently subscribed. The propertyChange
event is dispatched when this property changes.
Ta właściwość może być używana jako źródło dla tworzenia powiązań danych. Jeśli ta właściwość zostanie zmodyfikowana, zostanie wywołane zdarzenie propertyChange .
Implementacja
public function get subscribed():Booleantimestamp | właściwość |
timestamp:Number| Wersja języka: | ActionScript 3.0 |
| Wersje produktu: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Wersje środowiska wykonawczego: | 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.
Ta właściwość może być używana jako źródło dla tworzenia powiązań danych. Jeśli ta właściwość zostanie zmodyfikowana, zostanie wywołane zdarzenie propertyChange .
Implementacja
public function get timestamp():Number public function set timestamp(value:Number):voidAbstractConsumer | () | Konstruktor |
public function AbstractConsumer()| Wersja języka: | ActionScript 3.0 |
| Wersje produktu: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Wersje środowiska wykonawczego: | Flash Player 9, AIR 1.1 |
Constructs a Consumer.
Przykład ( Sposób korzystania z tego przykładu )
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 | () | metoda |
protected function buildSubscribeMessage():CommandMessage| Wersja języka: | ActionScript 3.0 |
| Wersje produktu: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Wersje środowiska wykonawczego: | Flash Player 9, AIR 1.1 |
Returns a subscribe message. This method should be overridden by subclasses if they need custom subscribe messages.
ZwracaCommandMessage — The subscribe CommandMessage.
|
buildUnsubscribeMessage | () | metoda |
protected function buildUnsubscribeMessage(preserveDurable:Boolean):CommandMessage| Wersja języka: | ActionScript 3.0 |
| Wersje produktu: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Wersje środowiska wykonawczego: | Flash Player 9, AIR 1.1 |
Returns an unsubscribe message. This method should be overridden by subclasses if they need custom unsubscribe messages.
Parametry
preserveDurable:Boolean — - when true, durable JMS subscriptions are not destroyed
allowing consumers to later resubscribe and receive missed messages
|
CommandMessage — The unsubscribe CommandMessage.
|
disconnect | () | metoda |
override public function disconnect():void| Wersja języka: | ActionScript 3.0 |
| Wersje produktu: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Wersje środowiska wykonawczego: | 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 | () | metoda |
public function receive(timestamp:Number = 0):void| Wersja języka: | ActionScript 3.0 |
| Wersje produktu: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Wersje środowiska wykonawczego: | 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.
Parametry
timestamp:Number (default = 0) |
subscribe | () | metoda |
public function subscribe(clientId:String = null):void| Wersja języka: | ActionScript 3.0 |
| Wersje produktu: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Wersje środowiska wykonawczego: | Flash Player 9, AIR 1.1 |
Subscribes to the remote destination.
Parametry
clientId:String (default = null) |
Zgłasza
InvalidDestinationError — If no destination is set.
|
unsubscribe | () | metoda |
public function unsubscribe(preserveDurable:Boolean = false):void| Wersja języka: | ActionScript 3.0 |
| Wersje produktu: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Wersje środowiska wykonawczego: | 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.
Parametry
preserveDurable:Boolean (default = false) |
message | Zdarzenie |
mx.messaging.events.MessageEventwłaściwość MessageEvent.type =
mx.messaging.events.MessageEvent.MESSAGE| Wersja języka: | ActionScript 3.0 |
| Wersje produktu: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| Wersje środowiska wykonawczego: | 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. |
Tue Jun 12 2018, 12:06 PM Z