org.waarp.common.cpu

Class WaarpConstraintLimitHandler

java.lang.Object

org.waarp.common.cpu.WaarpConstraintLimitHandler

All Implemented Interfaces:

Runnable

Direct Known Subclasses:

FtpConstraintLimitHandler, R66ConstraintLimitHandler

public abstract class WaarpConstraintLimitHandler
extends Object
implements Runnable

Abstract class for Constraint Limit Handler for Waarp project

Field Summary

Fields

Modifier and Type	Field and Description
String	lastAlert
static long	LOWBANDWIDTH_DEFAULT

Constructor Summary

Constructors

Constructor and Description
WaarpConstraintLimitHandler() Empty constructor
WaarpConstraintLimitHandler(long waitForNetOp, long timeOutCon, boolean useCpuLimit, boolean useJdKCpuLimit, double cpulimit, int channellimit) This constructor enables only Connection check ability
WaarpConstraintLimitHandler(long waitForNetOp2, long timeOutCon2, boolean useCpuLimit, boolean useJdKCpuLimit, double cpulimit, int channellimit, double lowcpuLimit, double highcpuLimit, double percentageDecrease, io.netty.handler.traffic.AbstractTrafficShapingHandler handler, long delay, long limitLowBandwidth) This constructor enables both Connection check ability and throttling bandwidth with cpu usage
WaarpConstraintLimitHandler(long waitForNetOp, long timeOutCon, boolean useJdkCpuLimit, double lowcpuLimit, double highcpuLimit, double percentageDecrease, io.netty.handler.traffic.AbstractTrafficShapingHandler handler, long delay, long limitLowBandwidth) This constructor enables only throttling bandwidth with cpu usage

Method Summary

Modifier and Type	Method and Description
boolean	checkConstraints()
boolean	checkConstraintsSleep(int step) Same as checkConstraints except that the thread will sleep some time proportionally to the current Load (if CPU related)
int	getChannelLimit()
double	getCpuLimit()
protected abstract int	getNumberLocalChannel()
protected abstract long	getReadLimit() Get the current setting on Read Limit (supposed to be not the value in the handler but in the configuration)
long	getSleepTime()
protected abstract long	getWriteLimit() Get the current setting on Write Limit (supposed to be not the value in the handler but in the configuration)
void	release() Release the resources
void	run() Check every delay if the current cpu usage needs to relax or to constraint the bandwidth
void	setChannelLimit(int channelLimit)
void	setCpuLimit(double cpuLimit)
void	setHandler(io.netty.handler.traffic.AbstractTrafficShapingHandler handler) Set the handler
void	setServer(boolean isServer) To explicitly set this handler as server mode

Methods inherited from class java.lang.Object

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

Field Detail

LOWBANDWIDTH_DEFAULT

public static final long LOWBANDWIDTH_DEFAULT

See Also:

Constant Field Values

lastAlert

public String lastAlert

Constructor Detail

WaarpConstraintLimitHandler

public WaarpConstraintLimitHandler()

Empty constructor

WaarpConstraintLimitHandler

public WaarpConstraintLimitHandler(long waitForNetOp,
                                   long timeOutCon,
                                   boolean useJdkCpuLimit,
                                   double lowcpuLimit,
                                   double highcpuLimit,
                                   double percentageDecrease,
                                   io.netty.handler.traffic.AbstractTrafficShapingHandler handler,
                                   long delay,
                                   long limitLowBandwidth)

This constructor enables only throttling bandwidth with cpu usage

Parameters:

waitForNetOp - 1000 ms as wait for a network operation

timeOutCon - 10000 ms as timeout limit

useJdkCpuLimit - True to use JDK Cpu native or False for JavaSysMon

lowcpuLimit - for proactive cpu limitation (throttling bandwidth) (0<= x < 1 & highcpulimit)

highcpuLimit - for proactive cpu limitation (throttling bandwidth) (0<= x <= 1) 0 meaning no throttle activated

percentageDecrease - for proactive cpu limitation, throttling bandwidth reduction (0 < x < 1) as 0.25 for 25% of reduction

handler - the GlobalTrafficShapingHandler associated (null to have no proactive cpu limitation)

delay - the delay between 2 tests for proactive cpu limitation

limitLowBandwidth - the minimal bandwidth (read or write) to apply when decreasing bandwidth (low limit = 4096)

WaarpConstraintLimitHandler

public WaarpConstraintLimitHandler(long waitForNetOp,
                                   long timeOutCon,
                                   boolean useCpuLimit,
                                   boolean useJdKCpuLimit,
                                   double cpulimit,
                                   int channellimit)

This constructor enables only Connection check ability

Parameters:

useCpuLimit - True to enable cpuLimit on connection check

useJdKCpuLimit - True to use JDK Cpu native or False for JavaSysMon

cpulimit - high cpu limit (0<= x < 1) to refuse new connections

channellimit - number of connection limit (0<= x)

WaarpConstraintLimitHandler

public WaarpConstraintLimitHandler(long waitForNetOp2,
                                   long timeOutCon2,
                                   boolean useCpuLimit,
                                   boolean useJdKCpuLimit,
                                   double cpulimit,
                                   int channellimit,
                                   double lowcpuLimit,
                                   double highcpuLimit,
                                   double percentageDecrease,
                                   io.netty.handler.traffic.AbstractTrafficShapingHandler handler,
                                   long delay,
                                   long limitLowBandwidth)

This constructor enables both Connection check ability and throttling bandwidth with cpu usage

Parameters:

waitForNetOp2 - 1000 ms as wait for a network operation

timeOutCon2 - 10000 ms as timeout limit

useCpuLimit - True to enable cpuLimit on connection check

useJdKCpuLimit - True to use JDK Cpu native or False for JavaSysMon

cpulimit - high cpu limit (0<= x < 1) to refuse new connections

channellimit - number of connection limit (0<= x)

lowcpuLimit - for proactive cpu limitation (throttling bandwidth) (0<= x < 1 & highcpulimit)

highcpuLimit - for proactive cpu limitation (throttling bandwidth) (0<= x <= 1) 0 meaning no throttle activated

percentageDecrease - for proactive cpu limitation, throttling bandwidth reduction (0 < x < 1) as 0.25 for 25% of reduction

handler - the GlobalTrafficShapingHandler associated (null to have no proactive cpu limitation)

delay - the delay between 2 tests for proactive cpu limitation

limitLowBandwidth - the minimal bandwidth (read or write) to apply when decreasing bandwidth (low limit = 4096)

Method Detail

release

public void release()

Release the resources

setServer

public void setServer(boolean isServer)

To explicitly set this handler as server mode

Parameters:

isServer -

checkConstraints

public boolean checkConstraints()

Returns:

True if one of the limit is exceeded. Always False if not a server mode

getNumberLocalChannel

protected abstract int getNumberLocalChannel()

Returns:

the current number of active Local Channel

checkConstraintsSleep

public boolean checkConstraintsSleep(int step)

Same as checkConstraints except that the thread will sleep some time proportionally to the current Load (if CPU related)

Parameters:

step - the current step in retry

Returns:

True if one of the limit is exceeded. Always False if not a server mode

getSleepTime

public long getSleepTime()

Returns:

a time below TIMEOUTCON with a random

getCpuLimit

public double getCpuLimit()

Returns:

the cpuLimit

setCpuLimit

public void setCpuLimit(double cpuLimit)

Parameters:

cpuLimit - the cpuLimit to set

getChannelLimit

public int getChannelLimit()

Returns:

the channelLimit

setChannelLimit

public void setChannelLimit(int channelLimit)

Parameters:

channelLimit - the channelLimit to set

getReadLimit

protected abstract long getReadLimit()

Get the current setting on Read Limit (supposed to be not the value in the handler but in the configuration)

Returns:

the current setting on Read Limit

getWriteLimit

protected abstract long getWriteLimit()

Get the current setting on Write Limit (supposed to be not the value in the handler but in the configuration)

Returns:

the current setting on Write Limit

setHandler

public void setHandler(io.netty.handler.traffic.AbstractTrafficShapingHandler handler)

Set the handler

Parameters:

handler -

run

public void run()

Check every delay if the current cpu usage needs to relax or to constraint the bandwidth

Specified by:

run in interface Runnable