flex.messaging.client
Class FlushResult

java.lang.Object
  flex.messaging.client.FlushResult

Direct Known Subclasses:

PollFlushResult

public class FlushResult
extends Object

Stores the messages that should be written to the network as a result of a flush invocation on a FlexClient's outbound queue.

Constructor Summary

FlushResult()
Constructs a FlushResult instance to return from a flush invocation on a FlexClient's outbound queue.

Method Summary

List	getMessages() Returns the messages to write to the network for this flush invocation.
int	getNextFlushWaitTimeMillis() Returns the wait time in milliseconds for when the next flush invocation should occur.
void	setMessages(List value) Sets the messages to write to the network for this flush invocation.
void	setNextFlushWaitTimeMillis(int value) Sets the wait time in milliseconds for when the next flush invocation should occur.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FlushResult

public FlushResult()

Constructs a FlushResult instance to return from a flush invocation on a FlexClient's outbound queue. This instance stores the list of messages to write over the network to the client as well as an optional wait time in milliseconds for when the next flush should be invoked.

Method Detail

getMessages

public List getMessages()

Returns the messages to write to the network for this flush invocation. This list may be null, in which case no messages are written.

Returns:

The messages to write to the network for this flush invocation.

setMessages

public void setMessages(List value)

Sets the messages to write to the network for this flush invocation.

Parameters:

value - The messages to write to the network for this flush invocation.

getNextFlushWaitTimeMillis

public int getNextFlushWaitTimeMillis()

Returns the wait time in milliseconds for when the next flush invocation should occur. If this value is 0, the default, a delayed flush is not scheduled and the next flush will depend upon the underlying Channel/Endpoint. For client-side polling Channels the next flush invocation will happen when the client sends its next poll request at its regular interval. For client-side Channels that support direct writes to the client a flush invocation is triggered when the next message is added to the outbound queue.

Returns:

The wait time in milliseconds before flush is next invoked. A value of 0, the default, indicates that the default flush behavior for the underlying Channel/Endpoint should be used.

setNextFlushWaitTimeMillis

public void setNextFlushWaitTimeMillis(int value)

Sets the wait time in milliseconds for when the next flush invocation should occur. If this value is 0, the default, a delayed flush is not scheduled and the next flush will depend upon the underlying Channel/Endpoint. For client-side polling Channels the next flush invocation will happen when the client sends its next poll request at its regular interval. For client-side Channels that support direct writes to the client a flush invocation is triggered when the next message is added to the outbound queue. Negative value assignments are treated as 0.

Parameters:

value - The wait time in milliseconds before flush will be invoked.