flex.messaging.services.messaging
Class ThrottleManager

java.lang.Object
  flex.management.ManageableComponent
      flex.messaging.services.messaging.ThrottleManager

All Implemented Interfaces:

Manageable, FlexComponent, FlexConfigurable

public class ThrottleManager
extends ManageableComponent

The ThrottleManager provides functionality to limit the frequency of messages routed through the system in message/second terms. Message frequency can be managed on a per-client basis and also on a per-destination basis by tweaking different parameters. Each MessageDestination has one ThrottleManager. Message frequency can be throttled differently for incoming messages, which are messages published by Flash/Flex producers, and for outgoing messages, which are messages consumed by Flash/Flex subscribers that may have bene produced by either Flash clients or external message producers (such as data feeds, JMS publishers, etc).

Field Summary

static String	LOG_CATEGORY
static int	RESULT_ERROR
static int	RESULT_IGNORE
static int	RESULT_OK
static int	RESULT_REPLACE
static String	TYPE

Constructor Summary

ThrottleManager()

ThrottleManager(boolean enableManagement)

Method Summary

void	removeClientThrottleMark(Object clientId)
void	setId(String id) Sets the id of the ManageableComponent.
void	setThrottleSettings(ThrottleSettings throttleSettings)
int	throttleIncomingMessage(Message msg)
int	throttleOutgoingMessage(Message msg, Object clientId)

Methods inherited from class flex.management.ManageableComponent

getControl, getId, getParent, initialize, isManaged, isStarted, isValid, setControl, setManaged, setParent, start, stop

Methods inherited from class java.lang.Object

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

Field Detail

LOG_CATEGORY

public static final String LOG_CATEGORY

See Also:

Constant Field Values

TYPE

public static final String TYPE

See Also:

Constant Field Values

RESULT_OK

public static final int RESULT_OK

See Also:

Constant Field Values

RESULT_IGNORE

public static final int RESULT_IGNORE

See Also:

Constant Field Values

RESULT_REPLACE

public static final int RESULT_REPLACE

See Also:

Constant Field Values

RESULT_ERROR

public static final int RESULT_ERROR

See Also:

Constant Field Values

Constructor Detail

ThrottleManager

public ThrottleManager()

ThrottleManager

public ThrottleManager(boolean enableManagement)

Method Detail

setId

public void setId(String id)

Description copied from class: ManageableComponent

Sets the id of the ManageableComponent. The id cannot be null and it cannot be changed after startup.

Overrides:

setId in class ManageableComponent

Parameters:

id - The id of the ManageableComponent.

setThrottleSettings

public void setThrottleSettings(ThrottleSettings throttleSettings)

throttleIncomingMessage

public int throttleIncomingMessage(Message msg)

throttleOutgoingMessage

public int throttleOutgoingMessage(Message msg,
                                   Object clientId)

removeClientThrottleMark

public void removeClientThrottleMark(Object clientId)