AbstractProducer - Referencia de la API de Adobe ActionScript® 3 (AS3 BlazeDS LCDS)

Paquete	mx.messaging
Clase	public class AbstractProducer
Herencia	AbstractProducer MessageAgent EventDispatcher Object
Subclases	MultiTopicProducer, Producer

Versión del lenguaje:

ActionScript 3.0

Versiones de producto:

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

Versiones de motor de ejecución:

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.

Propiedades públicas

Ocultar propiedades públicas heredadas

Mostrar propiedades públicas heredadas

	Propiedad		Definido por
		authenticated : Boolean [solo lectura] 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 [solo lectura] Provides access to the client id for the MessageAgent.	MessageAgent
		connected : Boolean [solo lectura] Indicates whether this MessageAgent is currently connected to its destination via its ChannelSet.	MessageAgent
		constructor : Object Una referencia a la clase de objeto o función constructora para una instancia de objeto determinada.	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

Métodos públicos

Ocultar métodos públicos heredados

Mostrar métodos públicos heredados

	Método		Definido por
		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 Registra un objeto de detector de eventos con un objeto EventDispatcher, de modo que el detector reciba la notificación de un evento.	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 [override] Disconnects the Producer from its remote destination.	AbstractProducer
		dispatchEvent(event:Event):Boolean Distribuye un evento en el flujo del evento.	EventDispatcher
		fault(errMsg:ErrorMessage, msg:IMessage):void Invoked by a MessageResponder upon receiving a fault for a sent message.	MessageAgent
		hasEventListener(type:String):Boolean Comprueba si el objeto EventDispatcher tiene detectores registrados para un tipo concreto de evento.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indica si un objeto tiene definida una propiedad especificada.	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 Indica si hay una instancia de la clase Object en la cadena de prototipo del objeto especificado como parámetro.	Object
		logout():void Logs the MessageAgent out from its remote destination.	MessageAgent
		propertyIsEnumerable(name:String):Boolean Indica si existe la propiedad especificada y si es enumerable.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Elimina un detector del objeto EventDispatcher.	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 Establece la disponibilidad de una propiedad dinámica para operaciones de bucle.	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 Devuelve la representación de cadena de este objeto, con formato según las convenciones específicas de configuración regional.	Object
		toString():String Devuelve la representación de cadena del objeto especificado.	Object
		valueOf():Object Devuelve el valor simple del objeto especificado.	Object
		willTrigger(type:String):Boolean Comprueba si hay registrado un detector de eventos con este objeto EventDispatcher o con cualquiera de sus ascendientes para el tipo de evento concreto.	EventDispatcher

Métodos protegidos

Ocultar métodos protegidos heredados

Mostrar métodos protegidos heredados

	Método		Definido por
		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

Eventos

Haga clic para obtener más información sobre los eventos

Ocultar eventos heredados

Mostrar eventos heredados

	Resumen	Definido por
acknowledge	Dispatched when an acknowledge message is received for a sent message.	MessageAgent
activate	[evento broadcast] Se distribuye cuando Flash Player o AIR pasan a estar activos.	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	[evento broadcast] Se distribuye cuando Flash Player o de AIR pasan a estar inactivos.	EventDispatcher
fault	Dispatched when a message fault occurs.	MessageAgent
propertyChange	Dispatched when the connected property of the MessageAgent changes.	MessageAgent

Información sobre propiedades

autoConnect

propiedad

autoConnect:Boolean

Versión del lenguaje:

ActionScript 3.0

Versiones de producto:

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

Versiones de motor de ejecución:

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.

Esta propiedad se puede utilizar como origen para la vinculación de datos. Cuando se modifica esta propiedad, distribuye el evento propertyChange .

Implementación
public function get autoConnect():Boolean
public function set autoConnect(value:Boolean):void

defaultHeaders

propiedad

defaultHeaders:Object

Versión del lenguaje:

ActionScript 3.0

Versiones de producto:

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

Versiones de motor de ejecución:

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.

Esta propiedad se puede utilizar como origen para la vinculación de datos. Cuando se modifica esta propiedad, distribuye el evento propertyChange .

Implementación
public function get defaultHeaders():Object
public function set defaultHeaders(value:Object):void

priority

propiedad

priority:int

Versión del lenguaje:

ActionScript 3.0

Versiones de producto:

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

Versiones de motor de ejecución:

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.

Esta propiedad se puede utilizar como origen para la vinculación de datos. Cuando se modifica esta propiedad, distribuye el evento propertyChange .

Implementación
public function get priority():int
public function set priority(value:int):void

reconnectAttempts

propiedad

reconnectAttempts:int

Versión del lenguaje:

ActionScript 3.0

Versiones de producto:

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

Versiones de motor de ejecución:

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.

Esta propiedad se puede utilizar como origen para la vinculación de datos. Cuando se modifica esta propiedad, distribuye el evento propertyChange .

Implementación
public function get reconnectAttempts():int
public function set reconnectAttempts(value:int):void

Elementos de API relacionados

mx.messaging.Producer.reconnectInterval

reconnectInterval

propiedad

reconnectInterval:int

Versión del lenguaje:

ActionScript 3.0

Versiones de producto:

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

Versiones de motor de ejecución:

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.

Esta propiedad se puede utilizar como origen para la vinculación de datos. Cuando se modifica esta propiedad, distribuye el evento propertyChange .

Implementación
public function get reconnectInterval():int
public function set reconnectInterval(value:int):void

Emite

ArgumentError — If the assigned value is negative.

Elementos de API relacionados

mx.messaging.Producer.reconnectInterval

Información sobre métodos

connect

()

método

public function connect():void

Versión del lenguaje:

ActionScript 3.0

Versiones de producto:

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

Versiones de motor de ejecución:

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.

Emite

InvalidDestinationError — If no destination is set.

Ejemplo
Cómo utilizar este ejemplo

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

disconnect

()

método

override public function disconnect():void

Versión del lenguaje:

ActionScript 3.0

Versiones de producto:

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

Versiones de motor de ejecución:

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

()

método

public function send(message:IMessage):void

Versión del lenguaje:

ActionScript 3.0

Versiones de producto:

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

Versiones de motor de ejecución:

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.

Parámetros

message:IMessage — The Message to send.

Emite

InvalidDestinationError — If no destination is set.

Ejemplo
Cómo utilizar este ejemplo

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

Avisos legales | Política de privacidad en línea

AbstractProducer - AS3 BlazeDS LCDS

Clases x

autoConnect

defaultHeaders

priority

reconnectAttempts

reconnectInterval

connect

disconnect

send