| { "type": "class", | |
| "qname": "mx.messaging.AbstractProducer", | |
| "baseClassname": "mx.messaging.MessageAgent" | |
| , | |
| "description": "The AbstractProducer is the base class for the Producer and MultiTopicConsumer classes. You use these classes to push messages to the server.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["BlazeDS 4", "LCDS 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "members": [ | |
| { "type": "accessor", | |
| "access": "read-write", | |
| "return": "Boolean", | |
| "qname": "autoConnect", | |
| "namespace": "public", | |
| "bindable": ["propertyChange"], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "If <code>true</code> the Producer automatically connects to its destination the first time the <code>send()</code> method is called. If <code>false</code> then the <code>connect()</code> method must be called explicitly to establish a connection to the destination. By default this property is <code>true</code>, but applications that need to operate in an offline mode may set this to <code>false</code> to prevent the <code>send()</code> method from connecting implicitly.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["BlazeDS 4", "LCDS 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "accessor", | |
| "access": "read-write", | |
| "return": "Object", | |
| "qname": "defaultHeaders", | |
| "namespace": "public", | |
| "bindable": ["propertyChange"], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "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.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["BlazeDS 4", "LCDS 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "accessor", | |
| "access": "read-write", | |
| "return": "int", | |
| "qname": "priority", | |
| "namespace": "public", | |
| "bindable": ["propertyChange"], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "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.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["BlazeDS 4", "LCDS 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "accessor", | |
| "access": "read-write", | |
| "return": "int", | |
| "qname": "reconnectAttempts", | |
| "namespace": "public", | |
| "bindable": ["propertyChange"], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "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. <p>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.</p>", | |
| "tags": [ | |
| { "tagName": "see", | |
| "values": ["mx.messaging.Producer#reconnectInterval"]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["BlazeDS 4", "LCDS 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "accessor", | |
| "access": "read-write", | |
| "return": "int", | |
| "qname": "reconnectInterval", | |
| "namespace": "public", | |
| "bindable": ["propertyChange"], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "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. <p>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.</p>", | |
| "tags": [ | |
| { "tagName": "see", | |
| "values": ["mx.messaging.Producer#reconnectInterval"]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["BlazeDS 4", "LCDS 3"]}, | |
| { "tagName": "throws", | |
| "values": ["ArgumentError If the assigned value is negative."]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "method", | |
| "qname": "disconnect", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": ["override"], | |
| "deprecated": {}, | |
| "description": "Disconnects the Producer from its remote destination. This method does not wait for outstanding network operations to complete. After invoking <code>disconnect()</code>, 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.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["BlazeDS 4", "LCDS 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "void", | |
| "params": []} | |
| , | |
| { "type": "method", | |
| "qname": "connect", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "Connects the Producer to its target destination. When a connection is established the <code>connected</code> property will change to <code>true</code> and this property is bindable and generates <code>PropertyChangeEvent</code>s. 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. <pre>\\n var producer:Producer = new Producer();\\n producer.destination = "TestTopic";\\n producer.addEventListener(PropertyChangeEvent.PROPERTY_CHANGE, handleConnect);\\n producer.connect();\\n </pre>", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["BlazeDS 4", "LCDS 3"]}, | |
| { "tagName": "throws", | |
| "values": ["mx.messaging.errors.InvalidDestinationError If no destination is set."]}, | |
| { "tagName": "example", | |
| "values": []}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "void", | |
| "params": []} | |
| , | |
| { "type": "method", | |
| "qname": "send", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "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. <pre>\\n var producer:Producer = new Producer();\\n producer.destination = "TestTopic";\\n var msg:AsyncMessage = new AsyncMessage();\\n msg.body = "test message";\\n producer.send(msg);\\n </pre>", | |
| "tags": [ | |
| { "tagName": "param", | |
| "values": ["message The Message to send."]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["BlazeDS 4", "LCDS 3"]}, | |
| { "tagName": "throws", | |
| "values": ["mx.messaging.errors.InvalidDestinationError If no destination is set."]}, | |
| { "tagName": "example", | |
| "values": []}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "void", | |
| "params": [{ "name": "message", "type": "mx.messaging.messages.IMessage"}]} | |
| ] | |
| } |