io.rsocket.plugins

Interface RequestInterceptor

All Superinterfaces:

Disposable

All Known Subinterfaces:

TrackingLeaseSender

All Known Implementing Classes:

WeightedStatsRequestInterceptor

public interface RequestInterceptor
extends Disposable

Class used to track the RSocket requests lifecycles. The main difference and advantage of this interceptor compares to RSocketInterceptor is that it allows intercepting the initial and terminal phases on every individual request.

Note, if any of the invocations will rise a runtime exception, this exception will be caught and be propagated to Operators.onErrorDropped(Throwable, Context)

Since:

1.1

Nested Class Summary

Nested classes/interfaces inherited from interface reactor.core.Disposable

Disposable.Composite, Disposable.Swap

Method Summary

Modifier and Type	Method and Description
void	onCancel(int streamId, FrameType requestType) Method which is being invoked once a successfully accepted request is cancelled.
void	onReject(Throwable rejectionReason, FrameType requestType, ByteBuf metadata) Method which is being invoked on the request rejection.
void	onStart(int streamId, FrameType requestType, ByteBuf metadata) Method which is being invoked on successful acceptance and start of a request.
void	onTerminate(int streamId, FrameType requestType, Throwable t) Method which is being invoked once a successfully accepted request is terminated.

Methods inherited from interface reactor.core.Disposable

dispose, isDisposed

Method Detail

onStart

void onStart(int streamId,
             FrameType requestType,
             @Nullable
             ByteBuf metadata)

Method which is being invoked on successful acceptance and start of a request.

Parameters:

streamId - used for the request

requestType - of the request. Must be one of the following types FrameType.REQUEST_FNF, FrameType.REQUEST_RESPONSE, FrameType.REQUEST_STREAM or FrameType.REQUEST_CHANNEL

metadata - taken from the initial frame

onTerminate

void onTerminate(int streamId,
                 FrameType requestType,
                 @Nullable
                 Throwable t)

Method which is being invoked once a successfully accepted request is terminated. This method can be invoked only after the onStart(int, FrameType, ByteBuf) method. This method is exclusive with onCancel(int, FrameType).

Parameters:

streamId - used by this request

requestType - of the request. Must be one of the following types FrameType.REQUEST_FNF, FrameType.REQUEST_RESPONSE, FrameType.REQUEST_STREAM or FrameType.REQUEST_CHANNEL

t - with which this finished has terminated. Must be one of the following signals

onCancel

void onCancel(int streamId,
              FrameType requestType)

Method which is being invoked once a successfully accepted request is cancelled. This method can be invoked only after the onStart(int, FrameType, ByteBuf) method. This method is exclusive with onTerminate(int, FrameType, Throwable).

Parameters:

requestType - of the request. Must be one of the following types FrameType.REQUEST_FNF, FrameType.REQUEST_RESPONSE, FrameType.REQUEST_STREAM or FrameType.REQUEST_CHANNEL

streamId - used by this request

onReject

void onReject(Throwable rejectionReason,
              FrameType requestType,
              @Nullable
              ByteBuf metadata)

Method which is being invoked on the request rejection. This method is being called only if the actual request can not be started and is called instead of the onStart(int, FrameType, ByteBuf) method. The reason for rejection can be one of the following:

• No available Lease on the requester or the responder sides
• Invalid Payload size or format on the Requester side, so the request is being rejected before the actual streamId is generated
• A second subscription on the ongoing Request

Parameters:

rejectionReason - exception which causes rejection of a particular request

requestType - of the request. Must be one of the following types FrameType.REQUEST_FNF, FrameType.REQUEST_RESPONSE, FrameType.REQUEST_STREAM or FrameType.REQUEST_CHANNEL

metadata - taken from the initial frame