com.alibaba.csp.sentinel

Class SphO

java.lang.Object

com.alibaba.csp.sentinel.SphO

public class SphO
extends Object

Conceptually, physical or logical resource that need protection should be surrounded by an entry. The requests to this resource will be blocked if any criteria is met, eg. when any Rule's threshold is exceeded. Once blocked, SphO#enter() will return false.

To configure the criteria, we can use XXXRuleManager.loadRules() to add rules. eg. FlowRuleManager.loadRules(List), DegradeRuleManager.loadRules(List), SystemRuleManager.loadRules(List).

Following code is an example. "abc" represent a unique name for the protected resource:

 public void foo() {
    if (SphO.entry("abc")) {
        try {
            // business logic
        } finally {
            SphO.exit(); // must exit()
        }
    } else {
        // failed to enter the protected resource.
    }
 }
 

Make sure SphO.entry() and exit() be paired in the same thread, otherwise ErrorEntryFreeException will be thrown.

Author:

jialiang.linjl, leyou, Eric Zhao

See Also:

SphU

Constructor Summary

Constructors

Constructor and Description
SphO()

Method Summary

Modifier and Type	Method and Description
static boolean	entry(Method method) Checking all Rules about the protected method.
static boolean	entry(Method method, EntryType type) Checking all Rules about the protected method.
static boolean	entry(Method method, EntryType type, int count) Checking all Rules about the protected method.
static boolean	entry(Method method, EntryType trafficType, int batchCount, Object... args) Record statistics and perform rule checking for the given method resource.
static boolean	entry(Method method, int batchCount) Checking all Rules about the protected method.
static boolean	entry(String name) Record statistics and perform rule checking for the given resource.
static boolean	entry(String name, EntryType type) Record statistics and perform rule checking for the given resource.
static boolean	entry(String name, EntryType type, int count) Record statistics and perform rule checking for the given resource.
static boolean	entry(String name, EntryType trafficType, int batchCount, Object... args) Record statistics and perform rule checking for the given resource.
static boolean	entry(String name, int batchCount) Record statistics and perform rule checking for the given resource.
static void	exit()
static void	exit(int count)
static void	exit(int count, Object... args)

Methods inherited from class java.lang.Object

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

Constructor Detail

SphO

public SphO()

Method Detail

entry

public static boolean entry(String name)

Record statistics and perform rule checking for the given resource.

Parameters:

name - the unique name of the protected resource

Returns:

true if no rule's threshold is exceeded, otherwise return false.

entry

public static boolean entry(Method method)

Checking all Rules about the protected method.

Parameters:

method - the protected method

Returns:

true if no rule's threshold is exceeded, otherwise return false.

entry

public static boolean entry(Method method,
                            int batchCount)

Checking all Rules about the protected method.

Parameters:

method - the protected method

batchCount - the amount of calls within the invocation (e.g. batchCount=2 means request for 2 tokens)

Returns:

true if no rule's threshold is exceeded, otherwise return false.

entry

public static boolean entry(String name,
                            int batchCount)

Record statistics and perform rule checking for the given resource.

Parameters:

name - the unique string for the resource

batchCount - the amount of calls within the invocation (e.g. batchCount=2 means request for 2 tokens)

Returns:

true if no rule's threshold is exceeded, otherwise return false.

entry

public static boolean entry(Method method,
                            EntryType type)

Checking all Rules about the protected method.

Parameters:

method - the protected method

type - the resource is an inbound or an outbound method. This is used to mark whether it can be blocked when the system is unstable, only inbound traffic could be blocked by SystemRule

Returns:

true if no rule's threshold is exceeded, otherwise return false.

entry

public static boolean entry(String name,
                            EntryType type)

Record statistics and perform rule checking for the given resource.

Parameters:

name - the unique name for the protected resource

type - the resource is an inbound or an outbound method. This is used to mark whether it can be blocked when the system is unstable, only inbound traffic could be blocked by SystemRule

Returns:

true if no rule's threshold is exceeded, otherwise return false.

entry

public static boolean entry(Method method,
                            EntryType type,
                            int count)

Checking all Rules about the protected method.

Parameters:

method - the protected method

type - the resource is an inbound or an outbound method. This is used to mark whether it can be blocked when the system is unstable, only inbound traffic could be blocked by SystemRule

count - the amount of calls within the invocation (e.g. batchCount=2 means request for 2 tokens)

Returns:

true if no rule's threshold is exceeded, otherwise return false.

entry

public static boolean entry(String name,
                            EntryType type,
                            int count)

Record statistics and perform rule checking for the given resource.

Parameters:

name - the unique name for the protected resource

type - the resource is an inbound or an outbound method. This is used to mark whether it can be blocked when the system is unstable, only inbound traffic could be blocked by SystemRule

count - the amount of calls within the invocation (e.g. batchCount=2 means request for 2 tokens)

Returns:

true if no rule's threshold is exceeded, otherwise return false.

entry

public static boolean entry(String name,
                            EntryType trafficType,
                            int batchCount,
                            Object... args)

Record statistics and perform rule checking for the given resource.

Parameters:

name - the unique name for the protected resource

trafficType - the traffic type (inbound, outbound or internal). This is used to mark whether it can be blocked when the system is unstable, only inbound traffic could be blocked by SystemRule

batchCount - the amount of calls within the invocation (e.g. batchCount=2 means request for 2 tokens)

args - args for parameter flow control or customized slots

Returns:

true if no rule's threshold is exceeded, otherwise return false.

entry

public static boolean entry(Method method,
                            EntryType trafficType,
                            int batchCount,
                            Object... args)

Record statistics and perform rule checking for the given method resource.

Parameters:

method - the protected method

trafficType - the traffic type (inbound, outbound or internal). This is used to mark whether it can be blocked when the system is unstable, only inbound traffic could be blocked by SystemRule

batchCount - the amount of calls within the invocation (e.g. batchCount=2 means request for 2 tokens)

args - args for parameter flow control or customized slots

Returns:

true if no rule's threshold is exceeded, otherwise return false.

exit

public static void exit(int count,
                        Object... args)

exit

public static void exit(int count)

exit

public static void exit()