| Package | com.lightstreamer.as_client |
| Class | public class Message |
| Inheritance | Message  Object |
| Property | Defined By | ||
|---|---|---|---|
| sequence : String [read-only]
The sequence name to which this message is associated. | Message | ||
| Method | Defined By | ||
|---|---|---|---|
Message(message:String, sequence:String, delayTimeout:int = -1)
Create an object to be used to send a message to a Lightstreamer Server. | Message | ||
| Constant | Defined By | ||
|---|---|---|---|
| UNORDERED_MESSAGES : String = UNORDERED_MESSAGES [static]
String costant representing the special sequence name to be used to prevent the sequential management of the messages on the server. | Message | ||
| sequence | property |
sequence:String [read-only] The sequence name to which this message is associated.
public function get sequence():String| Message | () | Constructor |
public function Message(message:String, sequence:String, delayTimeout:int = -1)Create an object to be used to send a message to a Lightstreamer Server. The object can be supplied to LSClient.sendMessage() in order to be forwarded to the server.
Parametersmessage:String — A text String to be interpreted by the Metadata Adapter. It should not be null
| |
sequence:String — The sequence identifier for this Message. Messages pertaining to the same sequence are
guaranteed to be processed by the server in order. The position of the message int the sequence is
given by the LSClient.sendMessage() method.
The sequence name must be alphanumeric, with the underscore character also allowed; it cannot be empty or null. If sequential management is undesired, the special UNORDERED_MESSAGES sequence identifier can be used. | |
delayTimeout:int (default = -1)The Server may, however, impose a lower limit on the timeout, in order to protect itself. A 0 timeout can be set, meaning that the Server will not wait at all for missing messages. When the UNORDERED_MESSAGES sequence is used, this timeout is ignored by the server; however, even in this case, if a hole in the sequence's progressive occurs, the Server may declare a message as lost after a Server-decided timeout. If no (or negative) value is supplied, the Server will use a timeout based on its own configuration. |
ConfigurationError — A sequence name was not specified.
|
See also
| UNORDERED_MESSAGES | Constant |
public static const UNORDERED_MESSAGES:String = UNORDERED_MESSAGESString costant representing the special sequence name to be used to prevent the sequential management of the messages on the server.