io.rsocket.loadbalance

Class WeightedStatsRequestInterceptor

java.lang.Object

io.rsocket.loadbalance.BaseWeightedStats

io.rsocket.loadbalance.WeightedStatsRequestInterceptor

All Implemented Interfaces:

WeightedStats, RequestInterceptor, Disposable

public class WeightedStatsRequestInterceptor
extends BaseWeightedStats
implements RequestInterceptor

RequestInterceptor that hooks into request lifecycle and calls methods of the parent class to manage tracking state and expose WeightedStats.

This interceptor the default mechanism for gathering stats when WeightedLoadbalanceStrategy is used with LoadbalanceRSocketClient.

Since:

1.1

See Also:

LoadbalanceRSocketClient, WeightedLoadbalanceStrategy

Nested Class Summary

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

Disposable.Composite, Disposable.Swap

Constructor Summary

Constructors

Constructor and Description
WeightedStatsRequestInterceptor()

Method Summary

Modifier and Type	Method and Description
void	dispose()
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 class io.rsocket.loadbalance.BaseWeightedStats

higherQuantileLatency, lowerQuantileLatency, pending, predictedLatency, toString, weightedAvailability

Methods inherited from class java.lang.Object

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

Methods inherited from interface reactor.core.Disposable

isDisposed

Methods inherited from interface io.rsocket.loadbalance.WeightedStats

wrap

Constructor Detail

WeightedStatsRequestInterceptor

public WeightedStatsRequestInterceptor()

Method Detail

onStart

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

Description copied from interface: RequestInterceptor

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

Specified by:

onStart in interface RequestInterceptor

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

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

Description copied from interface: RequestInterceptor

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

Specified by:

onTerminate in interface RequestInterceptor

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

public final void onCancel(int streamId,
                           FrameType requestType)

Description copied from interface: RequestInterceptor

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

Specified by:

onCancel in interface RequestInterceptor

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

onReject

public final void onReject(Throwable rejectionReason,
                           FrameType requestType,
                           ByteBuf metadata)

Description copied from interface: RequestInterceptor

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 RequestInterceptor.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

Specified by:

onReject in interface RequestInterceptor

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

dispose

public void dispose()

Specified by:

dispose in interface Disposable