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.

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 and Description
ENetConfigure.SelectorInfo	build() Returns the ENetConfigure.SelectorInfo instance created from the configuration settings.
boolean	isDefault() Returns true if this user-defined selector thread is the default selector.
ENetConfigure.SelectorInfoBuilder	isDefault(boolean flag) Sets the selector flag marking whether this is the default selector or not.
String	name() Returns the unique selector thread name.
ENetConfigure.SelectorInfoBuilder	name(String name) Sets the selector name to the given value.
long	parkTime() Returns the spin+park nanosecond park time.
ENetConfigure.SelectorInfoBuilder	parkTime(long time) Sets a spin+park selector thread's park time.
int	priority() Returns the selector thread priority.
ENetConfigure.SelectorInfoBuilder	priority(int priority) Sets the selector thread priority to the given value.
long	spinLimit() Returns a spin+park ESelector spin limit.
ENetConfigure.SelectorInfoBuilder	spinLimit(long limit) Sets a spinning selector thread's spin limit.
ThreadType	type() Returns the ESelector type.
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 String name()

Returns the unique selector thread name.

Returns:

selector thread name.

type

public ThreadType type()

Returns the ESelector type.

Returns:

selector type.

isDefault

public boolean isDefault()

Returns true if this user-defined selector thread is the default selector.

Returns:

true if the default selector thread.

priority

public int priority()

Returns the selector thread priority.

Returns:

thread priority.

spinLimit

public long spinLimit()

Returns a spin+park ESelector spin limit.

Returns:

spin limit.

parkTime

public long parkTime()

Returns the spin+park nanosecond park time.

Returns:

park time.

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(long 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 ≤ zero.

build

public ENetConfigure.SelectorInfo build()

Returns the ENetConfigure.SelectorInfo instance created from the configuration settings.

Returns:

SelectorInfo instance.

Throws:

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