com.hotels.styx.server.netty.NettyServerConfig Maven / Gradle / Ivy
/*
Copyright (C) 2013-2019 Expedia Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package com.hotels.styx.server.netty;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder;
import com.hotels.styx.server.ConnectorConfig;
import com.hotels.styx.server.HttpConnectorConfig;
import com.hotels.styx.server.HttpsConnectorConfig;
import java.util.Optional;
import java.util.stream.Stream;
import static com.google.common.base.MoreObjects.firstNonNull;
import static java.lang.Math.max;
import static java.lang.Runtime.getRuntime;
import static java.util.Collections.singleton;
import static java.util.stream.Collectors.toList;
/**
* Configuration values for the netty based web server.
*
*/
@JsonDeserialize(builder = NettyServerConfig.Builder.class)
public class NettyServerConfig {
public static final int HALF_OF_AVAILABLE_PROCESSORS = max(1, getRuntime().availableProcessors() / 2);
private int bossThreadsCount = 1;
private int workerThreadsCount = HALF_OF_AVAILABLE_PROCESSORS;
private int nioAcceptorBacklog = 1024;
private int maxInitialLength = 4096;
private int maxHeaderSize = 8192;
private int maxChunkSize = 8192;
private int requestTimeoutMs = 12000;
private int keepAliveTimeoutMillis = 12000;
private int maxConnectionsCount = 512;
private final Optional httpConnectorConfig;
private final Optional httpsConnectorConfig;
private final Iterable connectors;
public NettyServerConfig() {
this.httpConnectorConfig = Optional.of(new HttpConnectorConfig(8080));
this.httpsConnectorConfig = Optional.empty();
this.connectors = singleton(httpConnectorConfig.get());
}
protected NettyServerConfig(Builder builder) {
this.bossThreadsCount = firstNonNull(builder.bossThreadsCount, HALF_OF_AVAILABLE_PROCESSORS);
this.workerThreadsCount = firstNonNull(builder.workerThreadsCount, HALF_OF_AVAILABLE_PROCESSORS);
this.nioAcceptorBacklog = firstNonNull(builder.nioAcceptorBacklog, 1024);
this.maxInitialLength = firstNonNull(builder.maxInitialLength, 4096);
this.maxHeaderSize = firstNonNull(builder.maxHeaderSize, 8192);
this.maxChunkSize = firstNonNull(builder.maxChunkSize, 8192);
this.requestTimeoutMs = firstNonNull(builder.requestTimeoutMs, 12000);
this.keepAliveTimeoutMillis = firstNonNull(builder.keepAliveTimeoutMillis, 12000);
this.maxConnectionsCount = firstNonNull(builder.maxConnectionsCount, 512);
if (this.workerThreadsCount == 0) {
this.workerThreadsCount = HALF_OF_AVAILABLE_PROCESSORS;
}
this.httpConnectorConfig = Optional.ofNullable(builder.httpConnectorConfig);
this.httpsConnectorConfig = Optional.ofNullable(builder.httpsConnectorConfig);
this.connectors = connectorsIterable();
}
private Iterable connectorsIterable() {
return Stream.of(httpConnectorConfig, httpsConnectorConfig)
.filter(Optional::isPresent)
.map(Optional::get)
.collect(toList());
}
public Optional httpConnectorConfig() {
return httpConnectorConfig;
}
public Optional httpsConnectorConfig() {
return httpsConnectorConfig;
}
public Iterable connectors() {
return connectors;
}
/**
* Number of threads for establishing new channels.
*
* @return number of threads
*/
public int bossThreadsCount() {
return this.bossThreadsCount;
}
/**
* Worker threads are those performing all the asynchronous I/O operation on the inbound channel.
*
* @return number of threads
*/
public int workerThreadsCount() {
return this.workerThreadsCount;
}
public int nioAcceptorBacklog() {
return this.nioAcceptorBacklog;
}
/**
* The maximum length in bytes of the initial line of an HTTP message, e.g. {@code GET http://example.org/ HTTP/1.1}.
*
* @return maximum length of initial line
*/
public int maxInitialLength() {
return this.maxInitialLength;
}
/**
* The maximum combined size of the HTTP headers in bytes.
*
* @return maximum combined size of headers
*/
public int maxHeaderSize() {
return this.maxHeaderSize;
}
/**
* The maximum size of an HTTP chunk in bytes.
*
* @return maximum chunk size
*/
public int maxChunkSize() {
return this.maxChunkSize;
}
/**
* This parameter controls the amount of tolerated inactivity while the request is being received.
* If a client started sending a request, and then suddenly cuts it off, Styx would detect this after this
* duration has elapsed.
*
* @return time in millis
*/
public int requestTimeoutMillis() {
return this.requestTimeoutMs;
}
/**
* A timeout for idle persistent connections, in milliseconds.
*
* @return time in millis
*/
public int keepAliveTimeoutMillis() {
return this.keepAliveTimeoutMillis;
}
/**
* Max connections to server before we start rejecting them.
*
* @return max number of connections
*/
public int maxConnectionsCount() {
return this.maxConnectionsCount;
}
/**
* Builder.
*
* @param the type of the Builder
*/
@JsonPOJOBuilder(withPrefix = "set")
public static class Builder> {
protected Integer bossThreadsCount;
protected Integer workerThreadsCount;
protected Integer nioAcceptorBacklog;
protected Integer maxInitialLength;
protected Integer maxHeaderSize;
protected Integer maxChunkSize;
protected Integer requestTimeoutMs;
protected Integer keepAliveTimeoutMillis;
protected Integer maxConnectionsCount;
protected HttpConnectorConfig httpConnectorConfig;
protected HttpsConnectorConfig httpsConnectorConfig;
public Builder httpPort(int port) {
return (T) setHttpConnector(new HttpConnectorConfig(port));
}
@JsonProperty("bossThreadsCount")
public T setBossThreadsCount(Integer bossThreadsCount) {
this.bossThreadsCount = bossThreadsCount;
return (T) this;
}
@JsonProperty("workerThreadsCount")
public T setWorkerThreadsCount(Integer workerThreadsCount) {
this.workerThreadsCount = workerThreadsCount;
return (T) this;
}
@JsonProperty("nioAcceptorBacklog")
public T setNioAcceptorBacklog(Integer nioAcceptorBacklog) {
this.nioAcceptorBacklog = nioAcceptorBacklog;
return (T) this;
}
@JsonProperty("maxInitialLength")
public T setMaxInitialLength(Integer maxInitialLength) {
this.maxInitialLength = maxInitialLength;
return (T) this;
}
@JsonProperty("maxHeaderSize")
public T setMaxHeaderSize(Integer maxHeaderSize) {
this.maxHeaderSize = maxHeaderSize;
return (T) this;
}
@JsonProperty("maxChunkSize")
public T setMaxChunkSize(Integer maxChunkSize) {
this.maxChunkSize = maxChunkSize;
return (T) this;
}
@JsonProperty("requestTimeoutMillis")
public T setRequestTimeoutMs(Integer requestTimeoutMs) {
this.requestTimeoutMs = requestTimeoutMs;
return (T) this;
}
@JsonProperty("keepAliveTimeoutMillis")
public T setKeepAliveTimeoutMillis(Integer keepAliveTimeoutMillis) {
this.keepAliveTimeoutMillis = keepAliveTimeoutMillis;
return (T) this;
}
@JsonProperty("connectors")
public T setConnectors(Connectors connectors) {
this.httpConnectorConfig = connectors.http;
this.httpsConnectorConfig = connectors.https;
return (T) this;
}
public T setHttpConnector(HttpConnectorConfig httpConnector) {
this.httpConnectorConfig = httpConnector;
return (T) this;
}
public T setHttpsConnector(HttpsConnectorConfig httpsConnector) {
this.httpsConnectorConfig = httpsConnector;
return (T) this;
}
@JsonProperty("maxConnectionsCount")
public T setMaxConnectionsCount(Integer maxConnectionsCount) {
this.maxConnectionsCount = maxConnectionsCount;
return (T) this;
}
public NettyServerConfig build() {
return new NettyServerConfig(this);
}
}
/**
* Connectors.
*/
public static class Connectors {
private final HttpConnectorConfig http;
private final HttpsConnectorConfig https;
public Connectors(@JsonProperty("http") HttpConnectorConfig http,
@JsonProperty("https") HttpsConnectorConfig https) {
this.http = http;
this.https = https;
}
}
}