io.knotx.server.configuration

Class DropRequestOptions

java.lang.Object

io.knotx.server.configuration.DropRequestOptions

public class DropRequestOptions
extends java.lang.Object

Describes Knot.x HTTP Server dropping request options

Constructor Summary

Constructors

Constructor and Description
DropRequestOptions() Default constructor
DropRequestOptions(DropRequestOptions other) Copy constructor
DropRequestOptions(io.vertx.core.json.JsonObject json) Create an settings from JSON

Method Summary

Modifier and Type	Method and Description
long	getBackpressureBufferCapacity()
io.reactivex.BackpressureOverflowStrategy	getBackpressureStrategy()
int	getDropRequestResponseCode()
boolean	isEnabled()
DropRequestOptions	setBackpressureBufferCapacity(long backpressureBufferCapacity) Sets the backpressure buffer capacity, the number of request that single Server instance can support concurrently.
DropRequestOptions	setBackpressureStrategy(io.reactivex.BackpressureOverflowStrategy backpressureStrategy) Sets the strategy how to deal with backpressure buffer overflow.
DropRequestOptions	setDropRequestResponseCode(int dropRequestResponseCode) Sets the HTTP response code returned wheb request is dropped.
DropRequestOptions	setEnabled(boolean enabled) Enabled/disables request dropping (backpressure) on heavy load.
io.vertx.core.json.JsonObject	toJson() Convert to JSON

Methods inherited from class java.lang.Object

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

Constructor Detail

DropRequestOptions

public DropRequestOptions()

Default constructor

DropRequestOptions

public DropRequestOptions(DropRequestOptions other)

Copy constructor

Parameters:

other - the instance to copy

DropRequestOptions

public DropRequestOptions(io.vertx.core.json.JsonObject json)

Create an settings from JSON

Parameters:

json - the JSON

Method Detail

toJson

public io.vertx.core.json.JsonObject toJson()

Convert to JSON

Returns:

the JSON

isEnabled

public boolean isEnabled()

Returns:

true if request dropping (backpressure) is enabled

setEnabled

public DropRequestOptions setEnabled(boolean enabled)

Enabled/disables request dropping (backpressure) on heavy load. Default is true - enabled.

Parameters:

enabled - true - request drop enabled, false if disabled

Returns:

reference to this, so the API can be used fluently

getDropRequestResponseCode

public int getDropRequestResponseCode()

Returns:

HTTP response code used when request dropped

setDropRequestResponseCode

public DropRequestOptions setDropRequestResponseCode(int dropRequestResponseCode)

Sets the HTTP response code returned wheb request is dropped. Default is TOO_MANY_REQUESTS(429)

Parameters:

dropRequestResponseCode - status code integer

Returns:

reference to this, so the API can be used fluently

getBackpressureBufferCapacity

public long getBackpressureBufferCapacity()

Returns:

Capacity of the backpressure buffer

setBackpressureBufferCapacity

public DropRequestOptions setBackpressureBufferCapacity(long backpressureBufferCapacity)

Sets the backpressure buffer capacity, the number of request that single Server instance can support concurrently. Default value is 1000.

Parameters:

backpressureBufferCapacity - long - capacity of the buffer

Returns:

reference to this, so the API can be used fluently

getBackpressureStrategy

public io.reactivex.BackpressureOverflowStrategy getBackpressureStrategy()

Returns:

a backpressure overflow strategy.

setBackpressureStrategy

public DropRequestOptions setBackpressureStrategy(io.reactivex.BackpressureOverflowStrategy backpressureStrategy)

Sets the strategy how to deal with backpressure buffer overflow. Default is DROP_LATEST. Available values:

• ERROR - terminates the whole sequence
• DROP_OLDEST - drops the oldest value from the buffer
• DROP_LATEST - drops the latest value from the buffer

Parameters:

backpressureStrategy - a BackpressureOverflowStrategy value

Returns:

reference to this, so the API can be used fluently