ServerSettings

Contains values for configuring how a Server operates

These are all lower-level configuration settings that are for the most part not concerned with a server's application behavior

The low/high watermark percentages are used to help mitigate connection overload. When a server hits the high watermark percentage of live connections, it will change the idle timeout from maxIdleTime to highWaterMaxIdleTime in an attempt to more aggressively close idle connections. This will continue until the percentage drops below lowWatermarkPercentage. This can be totally disabled by just setting both watermarks to 1.

port: Port on which this Server will accept connections
maxConnections: Max number of simultaneous live connections
maxIdleTime: Maximum idle time for connections when in non high water conditions
lowWatermarkPercentage: Percentage of live/max connections which represent a normal state
highWatermarkPercentage: Percentage of live/max connections which represent a high water state.
highWaterMaxIdleTime: Max idle time for connections when in high water conditions.
tcpBacklogSize: Set the max number of simultaneous connections awaiting accepting, or None for NIO default
bindingAttemptDuration: The polling configuration for binding to a port. The The IOSystem will check PollingDuration.interval PollingDuration.maximumTries times. If the server cannot bind to the port, during this duration, it will shutdown. If this is not specified, the IOSystem will wait indefinitely.
delegatorCreationDuration: The polling configuration for creating The IOSystem will wait PollingDuration.interval for all colossus.core.Delegators to be created. It will fail to startup after PollingDuration.maximumTries and shutdown if it cannot successfully create the colossus.core.Delegators

Linear Supertypes

Serializable, Serializable, Product, Equals, AnyRef, Any

Instance Constructors

new ServerSettings(port: Int, maxConnections: Int = 1000, maxIdleTime: Duration = ..., lowWatermarkPercentage: Double = 0.75, highWatermarkPercentage: Double = 0.85, highWaterMaxIdleTime: FiniteDuration = ..., tcpBacklogSize: Option[Int] = scala.None, bindingAttemptDuration: PollingDuration = ..., delegatorCreationDuration: PollingDuration = ...)

port
Port on which this Server will accept connections
maxConnections
Max number of simultaneous live connections
maxIdleTime
Maximum idle time for connections when in non high water conditions
lowWatermarkPercentage
Percentage of live/max connections which represent a normal state
highWatermarkPercentage
Percentage of live/max connections which represent a high water state.
highWaterMaxIdleTime
Max idle time for connections when in high water conditions.
tcpBacklogSize
Set the max number of simultaneous connections awaiting accepting, or None for NIO default
bindingAttemptDuration
The polling configuration for binding to a port. The The IOSystem will check PollingDuration.interval PollingDuration.maximumTries times. If the server cannot bind to the port, during this duration, it will shutdown. If this is not specified, the IOSystem will wait indefinitely.
delegatorCreationDuration
The polling configuration for creating The IOSystem will wait PollingDuration.interval for all colossus.core.Delegators to be created. It will fail to startup after PollingDuration.maximumTries and shutdown if it cannot successfully create the colossus.core.Delegators

Value Members

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def ==(arg0: Any): Boolean

Definition Classes
Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
val bindingAttemptDuration: PollingDuration

The polling configuration for binding to a port.
The polling configuration for binding to a port. The The IOSystem will check PollingDuration.interval PollingDuration.maximumTries times. If the server cannot bind to the port, during this duration, it will shutdown. If this is not specified, the IOSystem will wait indefinitely.
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val delegatorCreationDuration: PollingDuration

The polling configuration for creating The IOSystem will wait PollingDuration.interval for all colossus.core.Delegators to be created. It will fail to startup after PollingDuration.maximumTries and shutdown if it cannot successfully create the colossus.core.Delegators
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
val highWaterMaxIdleTime: FiniteDuration

Max idle time for connections when in high water conditions.
def highWatermark: Double
val highWatermarkPercentage: Double

Percentage of live/max connections which represent a high water state.
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def lowWatermark: Double
val lowWatermarkPercentage: Double

Percentage of live/max connections which represent a normal state
val maxConnections: Int

Max number of simultaneous live connections
val maxIdleTime: Duration

Maximum idle time for connections when in non high water conditions
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val port: Int

Port on which this Server will accept connections
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val tcpBacklogSize: Option[Int]

Set the max number of simultaneous connections awaiting accepting, or None for NIO default
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Instance Constructors

Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

val bindingAttemptDuration: PollingDuration

def clone(): AnyRef

val delegatorCreationDuration: PollingDuration

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

final def getClass(): Class[_]

val highWaterMaxIdleTime: FiniteDuration

def highWatermark: Double

val highWatermarkPercentage: Double

final def isInstanceOf[T0]: Boolean

def lowWatermark: Double

val lowWatermarkPercentage: Double

val maxConnections: Int

val maxIdleTime: Duration

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val port: Int

final def synchronized[T0](arg0: ⇒ T0): T0

val tcpBacklogSize: Option[Int]

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped