LSMessageInfo Class Reference

The LSMessageInfo class contains a message object that will be sent to a Lightstreamer Server. More...

#import <LSMessageInfo.h>

List of all members.

Public Member Functions
(id)	- initWithMessage:sequence:delayTimeout:
Static Public Member Functions
(LSMessageInfo *)	+ messageInfoWithMessage:sequence:
	Creates and returns an LSMessageInfo object with the specified parameters.
(LSMessageInfo *)	+ messageInfoWithMessage:sequence:delayTimeout:
	Creates and returns an LSMessageInfo object with the specified parameters.
Properties
NSString *	message
	The text string to sent to the Server.
NSString *	sequence
	The sequence identifier for this Message.
NSTimeInterval	delayTimeout
	The timeout the Server should wait in case of a hole in the sequence's progressive before declaring the previous message as lost.
int	progressiveNumber
	The progressive number assigned to this message in its sequence.

---

Detailed Description

The LSMessageInfo class contains a message object that will be sent to a Lightstreamer Server.

The class contains the message string, the sequence to which such message is associated and a timeout to wait before the server declares lost the previous message in sequence.

---

Member Function Documentation

- (id) initWithMessage:		(NSString *)	message
sequence:		(NSString *)	sequence
delayTimeout:		(NSTimeInterval)	delayTimeout

+ (LSMessageInfo *) messageInfoWithMessage:		(NSString *)	message
sequence:		(NSString *)	sequence

Creates and returns an LSMessageInfo object with the specified parameters.

Parameters:

message	The text string to be sent to the Server. It will be interpreted by the Metadata Adapter.
sequence	The sequence identifier for this Message. Messages pertaining to the same sequence are guaranteed to be processed by the server in order. If sequential management is undesired, the special UNORDERED_MESSAGES sequence identifier can be used. A sequence can be composed only of alphanumeric characters and underscores.

Returns:

The LSMessageInfo object.

+ (LSMessageInfo *) messageInfoWithMessage:		(NSString *)	message
sequence:		(NSString *)	sequence
delayTimeout:		(NSTimeInterval)	delayTimeout

Creates and returns an LSMessageInfo object with the specified parameters.

Parameters:

message	The text string to be sent to the Server. It will be interpreted by the Metadata Adapter.
sequence	The sequence identifier for this Message. Messages pertaining to the same sequence are guaranteed to be processed by the server in order. If sequential management is undesired, the special UNORDERED_MESSAGES sequence identifier can be used. A sequence can be composed only of alphanumeric characters and underscores.
delayTimeout	The timeout the Server should wait in case of a hole in the sequence's progressive before declaring the previous message as lost. If 0 means that the Server will not wait at all for missing messages. If less than 0 the Server will use a timeout based on its own configuration.

Returns:

The LSMessageInfo object.

---

Property Documentation

- (NSTimeInterval) delayTimeout [read, write, assign]

The timeout the Server should wait in case of a hole in the sequence's progressive before declaring the previous message as lost.

If 0 means that the Server will not wait at all for missing messages. If less than 0 the Server will use a timeout based on its own configuration.
The default is -1.

- (NSString*) message [read, write, copy]

The text string to sent to the Server.

- (int) progressiveNumber [read, write, assign]

The progressive number assigned to this message in its sequence.

This value is assigned automatically when the message is sent. Any user-assigned value is ignored.
The default value is 0, which means the message has not yet been sent.

- (NSString*) sequence [read, write, copy]

The sequence identifier for this Message.

A sequence can be composed only of alphanumeric characters and underscores.

---

The documentation for this class was generated from the following file:

• LSMessageInfo.h