com.alibaba.csp.sentinel

Class CtSph

java.lang.Object

com.alibaba.csp.sentinel.CtSph

All Implemented Interfaces:

Sph, SphResourceTypeSupport

public class CtSph
extends Object
implements Sph

Author:

jialiang.linjl, leyou(lihao), Eric Zhao

See Also:

Sph

Constructor Summary

Constructors

Constructor and Description
CtSph()

Method Summary

Modifier and Type	Method and Description
AsyncEntry	asyncEntry(String name, EntryType type, int count, Object... args) Create a protected asynchronous resource.
AsyncEntry	asyncEntryWithType(String name, int resourceType, EntryType entryType, int count, boolean prioritized, Object[] args) Record statistics and perform rule checking for the given resource that indicates an async invocation.
Entry	entry(Method method) Record statistics and perform rule checking for the given method.
Entry	entry(Method method, EntryType type) Record statistics and perform rule checking for the given method.
Entry	entry(Method method, EntryType type, int count) Record statistics and perform rule checking for the given method.
Entry	entry(Method method, EntryType type, int count, Object... args) Record statistics and perform rule checking for the given resource.
Entry	entry(Method method, int count) Record statistics and perform rule checking for the given method.
Entry	entry(ResourceWrapper resourceWrapper, int count, Object... args) Do all Rules checking about the resource.
Entry	entry(String name) Record statistics and perform rule checking for the given resource.
Entry	entry(String name, EntryType type) Record statistics and perform rule checking for the given resource.
Entry	entry(String name, EntryType type, int count) Record statistics and perform rule checking for the given resource.
Entry	entry(String name, EntryType type, int count, Object... args) Record statistics and perform rule checking for the given resource.
Entry	entry(String name, int count) Record statistics and perform rule checking for the given resource.
static int	entrySize() Get current size of created slot chains.
Entry	entryWithPriority(String name, EntryType type, int count, boolean prioritized) Create a protected resource with priority.
Entry	entryWithPriority(String name, EntryType type, int count, boolean prioritized, Object... args) Create a protected resource with priority.
Entry	entryWithType(String name, int resourceType, EntryType entryType, int count, boolean prioritized, Object[] args) Record statistics and perform rule checking for the given resource with the provided classification.
Entry	entryWithType(String name, int resourceType, EntryType entryType, int count, Object[] args) Record statistics and perform rule checking for the given resource with provided classification.

Methods inherited from class java.lang.Object

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

Constructor Detail

CtSph

public CtSph()

Method Detail

entry

public Entry entry(ResourceWrapper resourceWrapper,
                   int count,
                   Object... args)
            throws BlockException

Do all Rules checking about the resource.

Each distinct resource will use a ProcessorSlot to do rules checking. Same resource will use same ProcessorSlot globally.

Note that total ProcessorSlot count must not exceed Constants.MAX_SLOT_CHAIN_SIZE, otherwise no rules checking will do. In this condition, all requests will pass directly, with no checking or exception.

Parameters:

resourceWrapper - resource name

count - tokens needed

args - arguments of user method call

Returns:

Entry represents this call

Throws:

BlockException - if any rule's threshold is exceeded

entrySize

public static int entrySize()

Get current size of created slot chains.

Returns:

size of created slot chains

Since:

0.2.0

entry

public Entry entry(String name)
            throws BlockException

Description copied from interface: Sph

Record statistics and perform rule checking for the given resource.

Specified by:

entry in interface Sph

Parameters:

name - the unique name of the protected resource

Returns:

the Entry of this invocation (used for mark the invocation complete and get context data).

Throws:

BlockException - if the block criteria is met

entry

public Entry entry(Method method)
            throws BlockException

Description copied from interface: Sph

Record statistics and perform rule checking for the given method.

Specified by:

entry in interface Sph

Parameters:

method - the protected method

Returns:

the Entry of this invocation (used for mark the invocation complete and get context data).

Throws:

BlockException - if the block criteria is met

entry

public Entry entry(Method method,
                   EntryType type)
            throws BlockException

Description copied from interface: Sph

Record statistics and perform rule checking for the given method.

Specified by:

entry in interface Sph

Parameters:

method - the protected method

type - 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

Returns:

the Entry of this invocation (used for mark the invocation complete and get context data).

Throws:

BlockException - if the block criteria is met

entry

public Entry entry(String name,
                   EntryType type)
            throws BlockException

Description copied from interface: Sph

Record statistics and perform rule checking for the given resource.

Specified by:

entry in interface Sph

Parameters:

name - the unique name for the protected resource

type - 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

Returns:

the Entry of this invocation (used for mark the invocation complete and get context data).

Throws:

BlockException - if the block criteria is met

entry

public Entry entry(Method method,
                   EntryType type,
                   int count)
            throws BlockException

Description copied from interface: Sph

Record statistics and perform rule checking for the given method.

Specified by:

entry in interface Sph

Parameters:

method - the protected method

type - 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

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

Returns:

the Entry of this invocation (used for mark the invocation complete and get context data).

Throws:

BlockException - if the block criteria is met

entry

public Entry entry(String name,
                   EntryType type,
                   int count)
            throws BlockException

Description copied from interface: Sph

Record statistics and perform rule checking for the given resource.

Specified by:

entry in interface Sph

Parameters:

name - the unique name for the protected resource

type - 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

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

Returns:

the Entry of this invocation (used for mark the invocation complete and get context data).

Throws:

BlockException - if the block criteria is met

entry

public Entry entry(Method method,
                   int count)
            throws BlockException

Description copied from interface: Sph

Record statistics and perform rule checking for the given method.

Specified by:

entry in interface Sph

Parameters:

method - the protected method

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

Returns:

the Entry of this invocation (used for mark the invocation complete and get context data).

Throws:

BlockException - if the block criteria is met

entry

public Entry entry(String name,
                   int count)
            throws BlockException

Description copied from interface: Sph

Record statistics and perform rule checking for the given resource.

Specified by:

entry in interface Sph

Parameters:

name - the unique string for the resource

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

Returns:

the Entry of this invocation (used for mark the invocation complete and get context data).

Throws:

BlockException - if the block criteria is met

entry

public Entry entry(Method method,
                   EntryType type,
                   int count,
                   Object... args)
            throws BlockException

Description copied from interface: Sph

Record statistics and perform rule checking for the given resource.

Specified by:

entry in interface Sph

Parameters:

method - the protected method

type - 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

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

args - parameters of the method for flow control or customized slots

Returns:

the Entry of this invocation (used for mark the invocation complete and get context data).

Throws:

BlockException - if the block criteria is met

entry

public Entry entry(String name,
                   EntryType type,
                   int count,
                   Object... args)
            throws BlockException

Description copied from interface: Sph

Record statistics and perform rule checking for the given resource.

Specified by:

entry in interface Sph

Parameters:

name - the unique name for the protected resource

type - 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

count - 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:

the Entry of this invocation (used for mark the invocation complete and get context data)

Throws:

BlockException - if the block criteria is met

asyncEntry

public AsyncEntry asyncEntry(String name,
                             EntryType type,
                             int count,
                             Object... args)
                      throws BlockException

Description copied from interface: Sph

Create a protected asynchronous resource.

Specified by:

asyncEntry in interface Sph

Parameters:

name - the unique name for the protected resource

type - 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

count - 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:

created asynchronous entry

Throws:

BlockException - if the block criteria is met

entryWithPriority

public Entry entryWithPriority(String name,
                               EntryType type,
                               int count,
                               boolean prioritized)
                        throws BlockException

Description copied from interface: Sph

Create a protected resource with priority.

Specified by:

entryWithPriority in interface Sph

Parameters:

name - the unique name for the protected resource

type - 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

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

prioritized - whether the entry is prioritized

Returns:

the Entry of this invocation (used for mark the invocation complete and get context data)

Throws:

BlockException - if the block criteria is met

entryWithPriority

public Entry entryWithPriority(String name,
                               EntryType type,
                               int count,
                               boolean prioritized,
                               Object... args)
                        throws BlockException

Description copied from interface: Sph

Create a protected resource with priority.

Specified by:

entryWithPriority in interface Sph

Parameters:

name - the unique name for the protected resource

type - 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

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

prioritized - whether the entry is prioritized

args - args for parameter flow control or customized slots

Returns:

the Entry of this invocation (used for mark the invocation complete and get context data)

Throws:

BlockException - if the block criteria is met

entryWithType

public Entry entryWithType(String name,
                           int resourceType,
                           EntryType entryType,
                           int count,
                           Object[] args)
                    throws BlockException

Description copied from interface: SphResourceTypeSupport

Record statistics and perform rule checking for the given resource with provided classification.

Specified by:

entryWithType in interface SphResourceTypeSupport

Parameters:

name - the unique name of the protected resource

resourceType - the classification of the resource

entryType - 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

count - 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:

the Entry of this invocation (used for mark the invocation complete and get context data)

Throws:

BlockException - if the block criteria is met

entryWithType

public Entry entryWithType(String name,
                           int resourceType,
                           EntryType entryType,
                           int count,
                           boolean prioritized,
                           Object[] args)
                    throws BlockException

Description copied from interface: SphResourceTypeSupport

Record statistics and perform rule checking for the given resource with the provided classification.

Specified by:

entryWithType in interface SphResourceTypeSupport

Parameters:

name - the unique name of the protected resource

resourceType - classification of the resource (e.g. Web or RPC)

entryType - 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

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

prioritized - whether the entry is prioritized

args - args for parameter flow control or customized slots

Returns:

the Entry of this invocation (used for mark the invocation complete and get context data)

Throws:

BlockException - if the block criteria is met

asyncEntryWithType

public AsyncEntry asyncEntryWithType(String name,
                                     int resourceType,
                                     EntryType entryType,
                                     int count,
                                     boolean prioritized,
                                     Object[] args)
                              throws BlockException

Description copied from interface: SphResourceTypeSupport

Record statistics and perform rule checking for the given resource that indicates an async invocation.

Specified by:

asyncEntryWithType in interface SphResourceTypeSupport

Parameters:

name - the unique name for the protected resource

resourceType - classification of the resource (e.g. Web or RPC)

entryType - 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

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

prioritized - whether the entry is prioritized

args - args for parameter flow control or customized slots

Returns:

the Entry of this invocation (used for mark the invocation complete and get context data)

Throws:

BlockException - if the block criteria is met