com.alibaba.csp.sentinel

Interface SphResourceTypeSupport

All Known Subinterfaces:

Sph

All Known Implementing Classes:

CtSph

public interface SphResourceTypeSupport

Since:

1.7.0

Author:

Eric Zhao

Method Summary

Modifier and Type	Method and Description
AsyncEntry	asyncEntryWithType(String name, int resourceType, EntryType trafficType, int batchCount, boolean prioritized, Object[] args) Record statistics and perform rule checking for the given resource that indicates an async invocation.
Entry	entryWithType(String name, int resourceType, EntryType trafficType, int batchCount, 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 trafficType, int batchCount, Object[] args) Record statistics and perform rule checking for the given resource with provided classification.

Method Detail

entryWithType

Entry entryWithType(String name,
                    int resourceType,
                    EntryType trafficType,
                    int batchCount,
                    Object[] args)
             throws BlockException

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

Parameters:

name - the unique name of the protected resource

resourceType - the classification of the 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:

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

Throws:

BlockException - if the block criteria is met

entryWithType

Entry entryWithType(String name,
                    int resourceType,
                    EntryType trafficType,
                    int batchCount,
                    boolean prioritized,
                    Object[] args)
             throws BlockException

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

Parameters:

name - the unique name of the protected resource

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

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)

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

AsyncEntry asyncEntryWithType(String name,
                              int resourceType,
                              EntryType trafficType,
                              int batchCount,
                              boolean prioritized,
                              Object[] args)
                       throws BlockException

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

Parameters:

name - the unique name for the protected resource

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

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)

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