flex.messaging.config
Class ThrottleSettings

java.lang.Object
  flex.messaging.config.ThrottleSettings

public class ThrottleSettings
extends Object

This configuration class is derived from optional properties that may be supplied in the <properties> section of a destination. It exists to capture properties related to message thottling in a way that simplifies the ThrottleManager's usage of the configuration.

Field Summary

static int	POLICY_ERROR Integer value of error policy
static int	POLICY_IGNORE Integer value of ignore policy
static int	POLICY_NONE Integer value of no policy
static int	POLICY_REPLACE Integer value of replace policy

Constructor Summary

ThrottleSettings()
Creates a ThrottleSettings instance with default settings.

Method Summary

String	getDestinationName() Returns the destination name for ThrottleSettings.
int	getInboundPolicy() Returns the inbound throttle policy.
int	getIncomingClientFrequency() Returns incoming client frequency (max-client-frequency).
int	getIncomingDestinationFrequency() Returns incoming destination frequency (max-frequency).
int	getOutboundPolicy() Returns the outbound throttle policy.
int	getOutgoingClientFrequency() Returns outgoing client frequency (max-client-frequency).
int	getOutgoingDestinationFrequency() Returns outgoing destination frequency (max-frequency).
boolean	isClientThrottleEnabled() Returns whether client throttling is enabled.
boolean	isDestinationThrottleEnabled() Returns whether destination throttling is enabled.
void	setDestinationName(String destinationName) Sets the destination name for ThrottleSettings.
void	setInboundPolicy(int inPolicy) Sets inbound throttle policy.
void	setIncomingClientFrequency(int n) Sets incoming client frequency (max-client-frequency).
void	setIncomingDestinationFrequency(int n) Sets incoming destination frequency (max-frequency).
void	setOutboundPolicy(int outPolicy) Sets the outbound throttle policy.
void	setOutgoingClientFrequency(int n) Sets outgoing client frequency (max-client-frequency).
void	setOutgoingDestinationFrequency(int n) Sets outgoing destination frequency (max-frequency).

Methods inherited from class java.lang.Object

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

Field Detail

POLICY_NONE

public static final int POLICY_NONE

Integer value of no policy

See Also:

Constant Field Values

POLICY_ERROR

public static final int POLICY_ERROR

Integer value of error policy

See Also:

Constant Field Values

POLICY_IGNORE

public static final int POLICY_IGNORE

Integer value of ignore policy

See Also:

Constant Field Values

POLICY_REPLACE

public static final int POLICY_REPLACE

Integer value of replace policy

See Also:

Constant Field Values

Constructor Detail

ThrottleSettings

public ThrottleSettings()

Creates a ThrottleSettings instance with default settings.

Method Detail

isClientThrottleEnabled

public boolean isClientThrottleEnabled()

Returns whether client throttling is enabled.

Returns:

true if the incoming client frequency or outgoing client frequency is greater than zero; otherwise false.

isDestinationThrottleEnabled

public boolean isDestinationThrottleEnabled()

Returns whether destination throttling is enabled.

Returns:

true if incoming destination frequency or outgoing destination frequency is greater than zero; otherwise false.

getInboundPolicy

public int getInboundPolicy()

Returns the inbound throttle policy.

Returns:

setInboundPolicy

public void setInboundPolicy(int inPolicy)

Sets inbound throttle policy. The inbound policy may be ERROR or IGNORE.

Parameters:

inPolicy -

getOutboundPolicy

public int getOutboundPolicy()

Returns the outbound throttle policy.

Returns:

setOutboundPolicy

public void setOutboundPolicy(int outPolicy)

Sets the outbound throttle policy. The outbound policy may be ERROR, IGNORE, or REPLACE.

Parameters:

outPolicy -

getDestinationName

public String getDestinationName()

Returns the destination name for ThrottleSettings.

Returns:

setDestinationName

public void setDestinationName(String destinationName)

Sets the destination name for ThrottleSettings. This is set automatically when NetworkSettings is assigned to a destination.

Parameters:

destinationName -

getIncomingClientFrequency

public int getIncomingClientFrequency()

Returns incoming client frequency (max-client-frequency).

Returns:

setIncomingClientFrequency

public void setIncomingClientFrequency(int n)

Sets incoming client frequency (max-client-frequency). Optional. Default value is 0.

Parameters:

n -

getIncomingDestinationFrequency

public int getIncomingDestinationFrequency()

Returns incoming destination frequency (max-frequency).

Returns:

setIncomingDestinationFrequency

public void setIncomingDestinationFrequency(int n)

Sets incoming destination frequency (max-frequency). Optional. Default value is 0.

Parameters:

n -

getOutgoingClientFrequency

public int getOutgoingClientFrequency()

Returns outgoing client frequency (max-client-frequency).

Returns:

setOutgoingClientFrequency

public void setOutgoingClientFrequency(int n)

Sets outgoing client frequency (max-client-frequency). Optional. Default value is 0.

Parameters:

n -

getOutgoingDestinationFrequency

public int getOutgoingDestinationFrequency()

Returns outgoing destination frequency (max-frequency).

Returns:

setOutgoingDestinationFrequency

public void setOutgoingDestinationFrequency(int n)

Sets outgoing destination frequency (max-frequency). Optional. Default value is 0.

Parameters:

n -