Interface LimitsFeatureConfig

All Superinterfaces:

Prototype.Api, Prototype.Factory<LimitsFeature>

All Known Implementing Classes:

LimitsFeatureConfig.BuilderBase.LimitsFeatureConfigImpl

public interface LimitsFeatureConfig
extends Prototype.Api

Interface generated from blueprint io.helidon.webserver.concurrency.limits.LimitsFeatureConfigBlueprint. Please add javadoc to blueprint, as it is currently missing.

See Also:

• builder()
• create()

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	LimitsFeatureConfig.Builder	Fluent API builder for LimitsFeature.
static class	LimitsFeatureConfig.BuilderBase<BUILDER extends LimitsFeatureConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends LimitsFeatureConfig>	Fluent API builder base for LimitsFeatureConfig.

Method Summary

Modifier and Type	Method	Description
static LimitsFeatureConfig.Builder	builder()	Create a new fluent API builder to customize configuration.
static LimitsFeatureConfig.Builder	builder(LimitsFeatureConfig instance)	Create a new fluent API builder from an existing instance.
Optional<Limit>	concurrencyLimit()	Concurrency limit to use to limit concurrent execution of incoming requests.
static LimitsFeatureConfig	create()	Create a new instance with default values.
static LimitsFeatureConfig	create(Config config)	Create a new instance from configuration.
boolean	enabled()	Whether this feature is enabled, defaults to true.
String	name()	Name of this instance.
Set<String>	sockets()	List of sockets to register this feature on.
double	weight()	Weight of the context feature.

Methods inherited from interface Prototype.Factory

build

Modifier and Type	Method	Description
LimitsFeature	build()	Create a new instance of the runtime type from this config object.

Method Details

builder

static LimitsFeatureConfig.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static LimitsFeatureConfig.Builder builder(LimitsFeatureConfig instance)

Create a new fluent API builder from an existing instance.

Parameters:

instance - an existing instance used as a base for the builder

Returns:

a builder based on an instance

create

static LimitsFeatureConfig create(Config config)

Create a new instance from configuration.

Parameters:

config - used to configure the new instance

Returns:

a new instance configured from configuration

create

static LimitsFeatureConfig create()

Create a new instance with default values.

Returns:

a new instance

weight

double weight()

Weight of the context feature. As it is used by other features, the default is quite high: 2000.0.

Returns:

weight of the feature

sockets

Set<String> sockets()

List of sockets to register this feature on. If empty, it would get registered on all sockets.

Returns:

socket names to register on, defaults to empty (all available sockets)

name

String name()

Name of this instance.

Returns:

instance name

concurrencyLimit

Optional<Limit> concurrencyLimit()

Concurrency limit to use to limit concurrent execution of incoming requests. The default is to have unlimited concurrency.

Returns:

concurrency limit

enabled

boolean enabled()

Whether this feature is enabled, defaults to true.

Returns:

whether to enable this feature