Package net.sf.eBus.config

Class EConfigure.ScheduledExecutorBuilder

java.lang.Object

net.sf.eBus.config.EConfigure.ThreadBuilder<EConfigure.ScheduledExecutor,EConfigure.ScheduledExecutorBuilder>

net.sf.eBus.config.EConfigure.ScheduledExecutorBuilder

Enclosing class:

EConfigure

public static final class EConfigure.ScheduledExecutorBuilder
extends EConfigure.ThreadBuilder<EConfigure.ScheduledExecutor,EConfigure.ScheduledExecutorBuilder>

Constructs an EConfigure.ScheduledExecutor configuration instance based on the parameters set via the builder's API. The supported scheduled executor properties are:

• name: required and must be unique among all eBus scheduled executors.
• thread type: required.
• priority: optional, defaults to EConfigure.DEFAULT_PRIORITY.
• spin limit: required if thread type is ThreadType.SPINYIELD or ThreadType.SPINPARK. Otherwise ignored.
• park time: required if thread type is ThreadType.SPINPARK. Otherwise ignored.
• thread affinity: optional. May be used with any thread type but generally used only with ThreadType.SPINNING.

A EScheduledExecutor instance can be created programmatically as follows:

import java.time.Duration;
import net.sf.eBus.client.EScheduledExecutor;
import net.sf.eBus.config.EConfigure;
import net.sf.eBus.config.EConfigure.ScheduledExecutor;
import net.sf.eBus.config.EConfigure.ScheduledExecutorBuilder;

final ScheduledExecutorBuilder builder = EConfigure.scheduledExecutorBuilder();
final ScheduledExecutor config = builder.name("FastTimer")
                                        .threadType(ThreadType.SPINPARK)
                                        .priority(8)
                                        .spinLimit(2_500_000)
                                        .parkTime(Duration.ofNanos(500L)
                                        .build();
final EScheduledExecutor executor = EScheduledExecutor.newScheduledExecutor(config);

Field Summary

Fields inherited from class net.sf.eBus.config.EConfigure.ThreadBuilder

mAffinity, mName, mNumThreads, mParkTime, mPriority, mSpinLimit, mThreadType

Method Summary

Modifier and Type	Method	Description
protected EConfigure.ScheduledExecutor	buildImpl()	Returns new subclass instance based on builder settings.
EConfigure.ScheduledExecutorBuilder	configuration(EConfigure.ScheduledExecutor config)	Copies in the settings from config to this builder.
protected EConfigure.ScheduledExecutorBuilder	self()	Returns subclass this reference.
EConfigure.ScheduledExecutorBuilder	threadType(ThreadType type)	Sets scheduled executor thread type.
protected Validator	validate(Validator problems)	Validates the ScheduledExecutor builder parameters.

Methods inherited from class net.sf.eBus.config.EConfigure.ThreadBuilder

build, name, parkTime, priority, spinLimit, threadAffinity, threadAffinity

Methods inherited from class java.lang.Object

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

Method Detail

self

protected EConfigure.ScheduledExecutorBuilder self()

Description copied from class: EConfigure.ThreadBuilder

Returns subclass this reference.

Specified by:

self in class EConfigure.ThreadBuilder<EConfigure.ScheduledExecutor,EConfigure.ScheduledExecutorBuilder>

Returns:

this.

buildImpl

protected EConfigure.ScheduledExecutor buildImpl()

Description copied from class: EConfigure.ThreadBuilder

Returns new subclass instance based on builder settings.

Specified by:

buildImpl in class EConfigure.ThreadBuilder<EConfigure.ScheduledExecutor,EConfigure.ScheduledExecutorBuilder>

Returns:

new subclass instance.

configuration

public EConfigure.ScheduledExecutorBuilder configuration(EConfigure.ScheduledExecutor config)

Copies in the settings from config to this builder. This method is provided for making changes to an existing configuration since EConfigure.ScheduledExecutor is immutable.

if config is null, then nothing is done and the builder remains unchanged.

Overrides:

configuration in class EConfigure.ThreadBuilder<EConfigure.ScheduledExecutor,EConfigure.ScheduledExecutorBuilder>

Parameters:

config - copy settings from this configuration.

Returns:

this scheduled executor builder.

threadType

public EConfigure.ScheduledExecutorBuilder threadType(ThreadType type)

Sets scheduled executor thread type.

Parameters:

type - thread type.

Returns:

this thread builder.

validate

protected Validator validate(Validator problems)

Validates the ScheduledExecutor builder parameters. This validation is "fail slow" meaning that a single validation call will determine all configuration errors.

Overrides:

validate in class EConfigure.ThreadBuilder<EConfigure.ScheduledExecutor,EConfigure.ScheduledExecutorBuilder>

Parameters:

problems - record configuration problems in this list.

Returns:

problems so validate calls may be chained together.