com.alibaba.csp.sentinel

Class Entry

java.lang.Object

com.alibaba.csp.sentinel.Entry

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

AsyncEntry

public abstract class Entry
extends Object
implements AutoCloseable

Each SphU#entry() will return an Entry. This class holds information of current invocation:

• createTime, the create time of this entry, using for rt statistics.
• current Node, that is statistics of the resource in current context.
• origin Node, that is statistics for the specific origin. Usually the origin could be the Service Consumer's app name, see ContextUtil.enter(String name, String origin)
• ResourceWrapper, that is resource name.

A invocation tree will be created if we invoke SphU#entry() multi times in the same Context, so parent or child entry may be held by this to form the tree. Since Context always holds the current entry in the invocation tree, every exit() call should modify Context.setCurEntry(Entry) as parent entry of this.

Author:

qinan.qn, jialiang.linjl, leyou(lihao), Eric Zhao

See Also:

SphU, Context, ContextUtil

Field Summary

Fields

Modifier and Type	Field and Description
protected ResourceWrapper	resourceWrapper

Constructor Summary

Constructors

Constructor and Description
Entry(ResourceWrapper resourceWrapper)

Method Summary

Modifier and Type	Method and Description
void	close() Equivalent to exit().
void	exit() Complete the current resource entry and restore the entry stack in context.
void	exit(int count)
abstract void	exit(int count, Object... args) Exit this entry.
BlockException	getBlockError()
long	getCompleteTimestamp()
long	getCreateTimestamp()
Node	getCurNode()
Throwable	getError()
abstract Node	getLastNode() Get related Node of the parent Entry.
Node	getOriginNode() Get origin Node of the this Entry.
ResourceWrapper	getResourceWrapper()
Entry	setBlockError(BlockException blockError)
Entry	setCompleteTimestamp(long completeTimestamp)
void	setCurNode(Node node)
void	setError(Throwable error)
void	setOriginNode(Node originNode)
protected abstract Entry	trueExit(int count, Object... args) Exit this entry.
abstract void	whenTerminate(BiConsumer<Context,Entry> handler) Like CompletableFuture since JDK 8, it guarantees specified handler is invoked when this entry terminated (exited), no matter it's blocked or permitted.

Methods inherited from class java.lang.Object

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

Field Detail

resourceWrapper

protected final ResourceWrapper resourceWrapper

Constructor Detail

Entry

public Entry(ResourceWrapper resourceWrapper)

Method Detail

getResourceWrapper

public ResourceWrapper getResourceWrapper()

exit

public void exit()
          throws ErrorEntryFreeException

Complete the current resource entry and restore the entry stack in context.

Throws:

ErrorEntryFreeException - if entry in current context does not match current entry

exit

public void exit(int count)
          throws ErrorEntryFreeException

Throws:

ErrorEntryFreeException

close

public void close()

Equivalent to exit(). Support try-with-resources since JDK 1.7.

Specified by:

close in interface AutoCloseable

Since:

1.5.0

exit

public abstract void exit(int count,
                          Object... args)
                   throws ErrorEntryFreeException

Exit this entry. This method should invoke if and only if once at the end of the resource protection.

Parameters:

count - tokens to release.

args - extra parameters

Throws:

ErrorEntryFreeException, - if Context.getCurEntry() is not this entry.

ErrorEntryFreeException

trueExit

protected abstract Entry trueExit(int count,
                                  Object... args)
                           throws ErrorEntryFreeException

Exit this entry.

Parameters:

count - tokens to release.

args - extra parameters

Returns:

next available entry after exit, that is the parent entry.

Throws:

ErrorEntryFreeException, - if Context.getCurEntry() is not this entry.

ErrorEntryFreeException

getLastNode

public abstract Node getLastNode()

Get related Node of the parent Entry.

Returns:

getCreateTimestamp

public long getCreateTimestamp()

getCompleteTimestamp

public long getCompleteTimestamp()

setCompleteTimestamp

public Entry setCompleteTimestamp(long completeTimestamp)

getCurNode

public Node getCurNode()

setCurNode

public void setCurNode(Node node)

getBlockError

public BlockException getBlockError()

setBlockError

public Entry setBlockError(BlockException blockError)

getError

public Throwable getError()

setError

public void setError(Throwable error)

getOriginNode

public Node getOriginNode()

Get origin Node of the this Entry.

Returns:

origin Node of the this Entry, may be null if no origin specified by ContextUtil.enter(String name, String origin).

setOriginNode

public void setOriginNode(Node originNode)

whenTerminate

public abstract void whenTerminate(BiConsumer<Context,Entry> handler)

Like CompletableFuture since JDK 8, it guarantees specified handler is invoked when this entry terminated (exited), no matter it's blocked or permitted. Use it when you did some STATEFUL operations on entries.

Parameters:

handler - handler function on the invocation terminates

Since:

1.8.0