com.datastax.oss.driver.api.core.session.throttling

Interface Throttled

public interface Throttled

A request that may be subjected to throttling by a RequestThrottler.

Method Summary

Modifier and Type	Method and Description
void	onThrottleFailure(RequestThrottlingException error) Invoked by the throttler to indicate that the request cannot be fulfilled.
void	onThrottleReady(boolean wasDelayed) Invoked by the throttler to indicate that the request can now start.

Method Detail

onThrottleReady

void onThrottleReady(boolean wasDelayed)

Invoked by the throttler to indicate that the request can now start. The request must wait for this call until it does any "actual" work (typically, writing to a connection).

Parameters:

wasDelayed - indicates whether the throttler delayed at all; this is so that requests don't have to rely on measuring time to determine it (this is useful for metrics).

onThrottleFailure

void onThrottleFailure(@NonNull
                       RequestThrottlingException error)

Invoked by the throttler to indicate that the request cannot be fulfilled. Typically, this means we've reached maximum capacity, and the request can't even be enqueued. This error must be rethrown to the client.

Parameters:

error - the error that the request should be completed (exceptionally) with.