AbstractProducer - API-referens för Adobe ActionScript® 3 (AS3 BlazeDS LCDS)

Paket	mx.messaging
Klass	public class AbstractProducer
Arv	AbstractProducer MessageAgent EventDispatcher Object
Underklasser	MultiTopicProducer, Producer

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 AbstractProducer is the base class for the Producer and MultiTopicConsumer classes. You use these classes to push messages to 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
		autoConnect : Boolean If true the Producer automatically connects to its destination the first time the send() method is called.	AbstractProducer
		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
		defaultHeaders : Object The default headers to apply to messages sent by the Producer.	AbstractProducer
		destination : String Provides access to the destination for the MessageAgent.	MessageAgent
		priority : int The default message priority for the messages sent by the Producer.	AbstractProducer
		reconnectAttempts : int The number of reconnect attempts that the Producer makes in the event that the destination is unavailable or the connection to the destination closes.	AbstractProducer
		reconnectInterval : int The number of milliseconds between reconnect attempts.	AbstractProducer
		requestTimeout : int Provides access to the request timeout in seconds for sent messages.	MessageAgent

Publika metoder

Dölj ärvda publika metoder

Visa ärvda publika metoder

	Metod		Definieras med
		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
		connect():void Connects the Producer to its target destination.	AbstractProducer
		disconnect():void [åsidosätt] Disconnects the Producer from its remote destination.	AbstractProducer
		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
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Tar bort en avlyssnare från EventDispatcher-objektet.	EventDispatcher
		send(message:IMessage):void Sends the specified message to its destination.	AbstractProducer
		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
		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
		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
		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
propertyChange	Dispatched when the connected property of the MessageAgent changes.	MessageAgent

Egenskapsdetaljer

autoConnect

egenskap

autoConnect: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

If true the Producer automatically connects to its destination the first time the send() method is called. If false then the connect() method must be called explicitly to establish a connection to the destination. By default this property is true, but applications that need to operate in an offline mode may set this to false to prevent the send() method from connecting implicitly.

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

defaultHeaders

egenskap

defaultHeaders: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

The default headers to apply to messages sent by the Producer. Any default headers that do not exist in the message will be created. If the message already contains a matching header, the value in the message takes precedence and the default header value is ignored.

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

priority

egenskap

priority: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 default message priority for the messages sent by the Producer. The valid values are 0 to 9 (0 being lowest) and -1 means that the Producer does not have a priority set. Note that if the message already has a priority defined, that takes precedence over Producer's priority.

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

reconnectAttempts

egenskap

reconnectAttempts: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 reconnect attempts that the Producer makes in the event that the destination is unavailable or the connection to the destination closes. A value of -1 enables infinite attempts. A value of zero disables reconnect attempts.

Reconnect attempts are made at a constant rate according to the reconnect interval value. When a reconnect attempt is made if the underlying channel for the Producer is not connected or attempting to connect the channel will start a connect attempt. Subsequent Producer reconnect 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 reconnectAttempts():int
public function set reconnectAttempts(value:int):void

Relaterade API-element

mx.messaging.Producer.reconnectInterval

reconnectInterval

egenskap

reconnectInterval: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 reconnect attempts. If a Producer doesn't receive an acknowledgement for a connect attempt, it will wait the specified number of milliseconds before making a subsequent reconnect attempt. Setting the value to zero disables reconnect attempts.

Reconnect attempts are made at a constant rate according to this value. When a reconnect attempt is made if the underlying channel for the Producer is not connected or attempting to connect the channel will start a connect attempt. Subsequent Producer reconnect 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 reconnectInterval():int
public function set reconnectInterval(value:int):void

Utlöser

ArgumentError — If the assigned value is negative.

Relaterade API-element

mx.messaging.Producer.reconnectInterval

Metoddetaljer

connect

()

metod

public function connect():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

Connects the Producer to its target destination. When a connection is established the connected property will change to true and this property is bindable and generates PropertyChangeEvents. The internal TRIGGER_CONNECT_OPERATION CommandMessage that is sent will result in an acknowledge or fault event depending upon whether the underlying channel establishes its connection.

Utlöser

InvalidDestinationError — If no destination is set.

Exempel
Så här använder du exemplet

         var producer:Producer = new Producer();
         producer.destination = "TestTopic";
         producer.addEventListener(PropertyChangeEvent.PROPERTY_CHANGE, handleConnect);
         producer.connect();

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 Producer from its remote destination. This method does not wait for outstanding network operations to complete. After invoking disconnect(), the Producer will report that it is not connected and it will not receive any outstanding message acknowledgements or faults. Disconnecting stops automatic reconnect attempts if they are running.

send

()

metod

public function send(message:IMessage):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

Sends the specified message to its destination. If the producer is being used for publish/subscribe messaging, only messages of type AsyncMessage should be sent unless a custom message type is being used and the message destination on the server has been configured to process the custom message type.

Parametrar

message:IMessage — The Message to send.

Utlöser

InvalidDestinationError — If no destination is set.

Exempel
Så här använder du exemplet

         var producer:Producer = new Producer();
         producer.destination = "TestTopic";
         var msg:AsyncMessage = new AsyncMessage();
         msg.body = "test message";
         producer.send(msg);

Juridiska meddelanden | Onlinesekretesspolicy

AbstractProducer - AS3 BlazeDS LCDS

Klasser x

autoConnect

defaultHeaders

priority

reconnectAttempts

reconnectInterval

connect

disconnect

send