net.hasor.neta.handler

接口 PipeLayer<RCV_UP,RCV_DOWN,SND_UP,SND_DOWN>

所有已知实现类:

PipeDuplexLayer, SslPipeLayer

函数接口:

这是一个函数接口, 因此可用作 lambda 表达式或方法引用的赋值目标。

@FunctionalInterface
public interface PipeLayer<RCV_UP,RCV_DOWN,SND_UP,SND_DOWN>

PipeLayer is a Duplexer, The data flow direction is identified by the isRcv parameter. A protocol stack has four endpoints: RCV_UP, RCV_DOWN, SND_UP, and SND_DOWN, these endpoints can store some data. Some of these endpoints come from Buffers, e.g, RCV_UP is located low on the stack. SND_DOWN is the temporary storage used to receive the output of the pipeline. When there are multiple PipeLayer layers, the endpoints are linked, e.g, first PipeLayer RCV_DOWN -> next PipeLayer RCV_UP

         ┏━━━━━━━━━━━━━━━━━━━━━━━━━┓    ┏━━━━━━━━━━━━━━━━━━━━━━━━━┓
 DATA -> ┃ RCV_UP         RCV_DOWN ┃ -> ┃ RCV_UP         RCV_DOWN ┃  -> ...
         ┃                         ┃    ┃                         ┃
         ┃      PipeLayer (1)      ┃    ┃      PipeLayer (2)      ┃
         ┃                         ┃    ┃                         ┃
  ... <- ┃ SND_DOWN         SND_UP ┃ <- ┃ SND_DOWN         SND_UP ┃  <- DATA
         ┗━━━━━━━━━━━━━━━━━━━━━━━━━┛    ┗━━━━━━━━━━━━━━━━━━━━━━━━━┛
 

This design means that during any rcv/snd, upstream and downstream of the pipeline can be operated.

版本:

: 2023-10-17

作者:

赵永春 (zyc@hasor.net)

另请参阅:

PipeHandler, PipeConfig

方法概要

限定符和类型	方法和说明
default PipeStatus	doError(PipeContext context, boolean isRcv, Throwable e, PipeExceptionHolder eh) Gets called if a Throwable was thrown.
PipeStatus	doLayer(PipeContext context, boolean isRcv, PipeRcvQueue<RCV_UP> rcvUp, PipeSndQueue<RCV_DOWN> rcvDown, PipeRcvQueue<SND_UP> sndUp, PipeSndQueue<SND_DOWN> sndDown) process data the protocol stack.
default void	init(PipeContext context) Initialize the protocol stack, when the Connected.
default void	release(PipeContext context) release protocol stack, connection close.

方法详细资料

init

default void init(PipeContext context)
           throws Throwable

Initialize the protocol stack, when the Connected.

抛出:

Throwable

doLayer

PipeStatus doLayer(PipeContext context,
                   boolean isRcv,
                   PipeRcvQueue<RCV_UP> rcvUp,
                   PipeSndQueue<RCV_DOWN> rcvDown,
                   PipeRcvQueue<SND_UP> sndUp,
                   PipeSndQueue<SND_DOWN> sndDown)
            throws Throwable

process data the protocol stack. After the doLayer method returns, The PipeRcvQueue.rcvSubmit()/PipeSndQueue.sndSubmit() method of (RCV_UP, RCV_DOWN, SND_UP, SND_DOWN) will be called.

• When the method throws, (RCV_UP, RCV_DOWN, SND_UP, SND_DOWN) keep state, and call doError(PipeContext, boolean, Throwable, PipeExceptionHolder).

抛出:

Throwable

doError

default PipeStatus doError(PipeContext context,
                           boolean isRcv,
                           Throwable e,
                           PipeExceptionHolder eh)
                    throws Throwable

Gets called if a Throwable was thrown. If an exception occurs, piple executes in the following way. After the doError method returns, The PipeRcvQueue.rcvReset()/PipeSndQueue.sndReset() method of (RCV_UP, RCV_DOWN, SND_UP, SND_DOWN) will be called

  ... -> doLayer -> doLayer -> Exception
                                   |
                                doError -> doError -> doError...
 

You can clear the exception flag with the PipeExceptionHolder.clear() method, and piple execution will continue normally

  ... -> doLayer -> doError -> doError(invoker clear) -> doLayer -> ...
 

抛出:

Throwable

release

default void release(PipeContext context)

release protocol stack, connection close.