Package net.sf.eBus.config

Class ENetConfigure.SelectorInfoBuilder

java.lang.Object

net.sf.eBus.config.ENetConfigure.SelectorInfoBuilder

Enclosing class:

ENetConfigure

public static final class ENetConfigure.SelectorInfoBuilder
extends Object

Constructs an ENetConfigure.SelectorInfo instance based on the parameters set via the builder's API. The minimally allowed configuration is based on the selector's thread type. In all cases a unique selector name and type must be provided. The selector parameters are:

• name: unique selector name. Uniqueness is within the JVM.

  Required: Yes.

• type: selector thread type.

  Required: Yes.

• isDefault: if set to true, then this is the default selector for all channels which do not specify a selector.

  Required: No.

  Default Setting: false.

• priority: the selector thread's priority. Should be one of Thread.MIN_PRIORITY, Thread.NORM_PRIORITY, or Thread.MAX_PRIORITY.

  Required: No.

  Default Setting: ENetConfigure.DEFAULT_PRIORITY.

• spinLimit: number of times a selector thread may spin before parking.

  Required: No.

  Default Setting: ENetConfigure.DEFAULT_SPIN_LIMIT.

• parkTime: nanosecond duration for a selector park.

  Required: No.

  Default Setting: ENetConfigure.DEFAULT_PARK_TIME.

• threadAffinity: ThreadAffinityConfigure used to associate selector thread with a core. Thread affinity should be considered when using a spinning thread type.

  Required: No.

  Default Setting: null.

Example building a SelectorInfo

 final ENetConfigure.SelectorInfoBuilder builder = ENetConfigure.selectorBuilder();
 final ENetConfigure.SelectorInfo selectorInfo = builder.name("app_selector")
                                                        .type(ThreadType.SPINPARK)
                                                        .isDefault(true)
                                                        .spinLimit(2_000_000L)
                                                        .parkTime(500L)
                                                        .build();

Method Summary

Modifier and Type	Method	Description
ENetConfigure.SelectorInfo	build()	Returns the ENetConfigure.SelectorInfo instance created from the configuration settings.
ENetConfigure.SelectorInfoBuilder	isDefault(boolean flag)	Sets the selector flag marking whether this is the default selector or not.
ENetConfigure.SelectorInfoBuilder	name(String name)	Sets the selector name to the given value.
ENetConfigure.SelectorInfoBuilder	parkTime(Duration time)	Sets a spin+park selector thread's park time.
ENetConfigure.SelectorInfoBuilder	priority(int priority)	Sets the selector thread priority to the given value.
ENetConfigure.SelectorInfoBuilder	spinLimit(long limit)	Sets a spinning selector thread's spin limit.
ENetConfigure.SelectorInfoBuilder	threadAffinity(ThreadAffinityConfigure affinity)	Sets thread affinity configuration.
ENetConfigure.SelectorInfoBuilder	type(ThreadType type)	Sets the selector thread type to the given value.

Methods inherited from class java.lang.Object

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

Method Detail

name

public ENetConfigure.SelectorInfoBuilder name(String name)

Sets the selector name to the given value.

Parameters:

name - selector name.

Returns:

this SelectorInfoBuilder.

Throws:

com.typesafe.config.ConfigException - if name is either null or an empty string.

type

public ENetConfigure.SelectorInfoBuilder type(ThreadType type)

Sets the selector thread type to the given value.

Parameters:

type - selector thread type.

Returns:

this SelectorInfoBuilder.

Throws:

com.typesafe.config.ConfigException - if type is null.

isDefault

public ENetConfigure.SelectorInfoBuilder isDefault(boolean flag)

Sets the selector flag marking whether this is the default selector or not.

Parameters:

flag - true if this is the default selector thread.

Returns:

this SelectorInfoBuilder.

priority

public ENetConfigure.SelectorInfoBuilder priority(int priority)

Sets the selector thread priority to the given value.

Parameters:

priority - thread priority.

Returns:

this SelectorInfoBuilder.

Throws:

com.typesafe.config.ConfigException - if priority is < Thread.MIN_PRIORITY or > Thread.MAX_PRIORITY.

spinLimit

public ENetConfigure.SelectorInfoBuilder spinLimit(long limit)

Sets a spinning selector thread's spin limit.

Parameters:

limit - number of time the thread may spin on select before parking.

Returns:

this SelectorInfoBuilder.

Throws:

com.typesafe.config.ConfigException - if limit is ≤ zero.

parkTime

public ENetConfigure.SelectorInfoBuilder parkTime(Duration time)

Sets a spin+park selector thread's park time.

Parameters:

time - nanosecond thread park time.

Returns:

this SelectorInfoBuilder.

Throws:

com.typesafe.config.ConfigException - if time is null or ≤ zero.

threadAffinity

public ENetConfigure.SelectorInfoBuilder threadAffinity(ThreadAffinityConfigure affinity)

Sets thread affinity configuration.

Parameters:

affinity - thread affinity configuration. May be null.

Returns:

this SelectorInfoBuilder.

build

public ENetConfigure.SelectorInfo build()

Returns the ENetConfigure.SelectorInfo instance created from the configuration settings. Sets spin limit for spin/park and spin/yield thread types to ENetConfigure.DEFAULT_SPIN_LIMIT if spin limit is not set. Sets park time to ENetConfigure.DEFAULT_PARK_TIME if not configured for spin/park thread type.

Returns:

SelectorInfo instance.

Throws:

com.typesafe.config.ConfigException - if SelectorInfo configuration is invalid.