flex.messaging.client
Class PollFlushResult

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

public class PollFlushResult
extends FlushResult

Extends FlushResult and adds additional properties for controlling client polling behavior.

Constructor Summary

PollFlushResult()

Method Summary

boolean	isAvoidBusyPolling() Indicates whether the handling of this result should attempt to avoid potential busy-polling cycles.
boolean	isClientProcessingSuppressed() Indicates whether client processing of this result should be suppressed.
void	setAvoidBusyPolling(boolean value) Set to true to signal that handling for this result should attempt to avoid potential busy-polling cycles.
void	setClientProcessingSuppressed(boolean value) Set to true to suppress client processing of this result.

Methods inherited from class flex.messaging.client.FlushResult

getMessages, getNextFlushWaitTimeMillis, setMessages, setNextFlushWaitTimeMillis

Methods inherited from class java.lang.Object

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

Constructor Detail

PollFlushResult

public PollFlushResult()

Method Detail

isAvoidBusyPolling

public boolean isAvoidBusyPolling()

Indicates whether the handling of this result should attempt to avoid potential busy-polling cycles. This will be set to true in the case of two clients that are both long-polling the server over the same session.

Returns:

true if the handling of this result should attempt to avoid potential busy-polling cycles.

setAvoidBusyPolling

public void setAvoidBusyPolling(boolean value)

Set to true to signal that handling for this result should attempt to avoid potential busy-polling cycles.

Parameters:

value - true to signal that handling for this result should attempt to avoid potential busy-polling cycles.

isClientProcessingSuppressed

public boolean isClientProcessingSuppressed()

Indicates whether client processing of this result should be suppressed. This should be true for results generated for poll requests that arrive while a long-poll request from the same client is being serviced to avoid a busy polling cycle.

Returns:

true if client processing of this result should be suppressed; otherwise false.

setClientProcessingSuppressed

public void setClientProcessingSuppressed(boolean value)

Set to true to suppress client processing of this result. Default is false. This should be set to true for results generated for poll requests that arrive while a long-poll request from the same client is being serviced to avoid a busy polling cycle.

Parameters:

value - true to suppress client processing of the result.