com.alibaba.csp.sentinel.slots.block.flow

Class FlowRule

java.lang.Object

com.alibaba.csp.sentinel.slots.block.AbstractRule

com.alibaba.csp.sentinel.slots.block.flow.FlowRule

All Implemented Interfaces:

Rule

public class FlowRule
extends AbstractRule

Each flow rule is mainly composed of three factors: grade, strategy and controlBehavior:

• The grade represents the threshold type of flow control (by QPS or thread count).
• The strategy represents the strategy based on invocation relation.
• The controlBehavior represents the QPS shaping behavior (actions on incoming request when QPS exceeds the threshold).

Author:

jialiang.linjl, Eric Zhao

Constructor Summary

Constructors

Constructor and Description
FlowRule()
FlowRule(String resourceName)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
ClusterFlowConfig	getClusterConfig()
int	getControlBehavior()
double	getCount()
int	getGrade()
int	getMaxQueueingTimeMs()
String	getRefResource()
int	getStrategy()
int	getWarmUpPeriodSec()
int	hashCode()
boolean	isClusterMode()
boolean	passCheck(Context context, DefaultNode node, int acquireCount, Object... args) Check whether current statistical indicators meet this rule, which means not exceeding any threshold.
FlowRule	setClusterConfig(ClusterFlowConfig clusterConfig)
FlowRule	setClusterMode(boolean clusterMode)
FlowRule	setControlBehavior(int controlBehavior)
FlowRule	setCount(double count)
FlowRule	setGrade(int grade)
FlowRule	setMaxQueueingTimeMs(int maxQueueingTimeMs)
FlowRule	setRefResource(String refResource)
FlowRule	setStrategy(int strategy)
FlowRule	setWarmUpPeriodSec(int warmUpPeriodSec)
String	toString()

Methods inherited from class com.alibaba.csp.sentinel.slots.block.AbstractRule

as, getLimitApp, getResource, setLimitApp, setResource

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FlowRule

public FlowRule()

FlowRule

public FlowRule(String resourceName)

Method Detail

getControlBehavior

public int getControlBehavior()

setControlBehavior

public FlowRule setControlBehavior(int controlBehavior)

getMaxQueueingTimeMs

public int getMaxQueueingTimeMs()

setMaxQueueingTimeMs

public FlowRule setMaxQueueingTimeMs(int maxQueueingTimeMs)

getWarmUpPeriodSec

public int getWarmUpPeriodSec()

setWarmUpPeriodSec

public FlowRule setWarmUpPeriodSec(int warmUpPeriodSec)

getGrade

public int getGrade()

setGrade

public FlowRule setGrade(int grade)

getCount

public double getCount()

setCount

public FlowRule setCount(double count)

getStrategy

public int getStrategy()

setStrategy

public FlowRule setStrategy(int strategy)

getRefResource

public String getRefResource()

setRefResource

public FlowRule setRefResource(String refResource)

isClusterMode

public boolean isClusterMode()

setClusterMode

public FlowRule setClusterMode(boolean clusterMode)

getClusterConfig

public ClusterFlowConfig getClusterConfig()

setClusterConfig

public FlowRule setClusterConfig(ClusterFlowConfig clusterConfig)

passCheck

public boolean passCheck(Context context,
                         DefaultNode node,
                         int acquireCount,
                         Object... args)

Description copied from interface: Rule

Check whether current statistical indicators meet this rule, which means not exceeding any threshold.

Parameters:

context - current Context

node - current Node

acquireCount - tokens needed.

args - arguments of the original invocation.

Returns:

If current statistical indicators not exceeding any threshold return true, otherwise return false.

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractRule

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractRule

toString

public String toString()

Overrides:

toString in class Object