Package net.sodacan.core.config

Class BaseBuilder

java.lang.Object

net.sodacan.core.config.BaseBuilder

Direct Known Subclasses:

SimpleBuilder

public abstract class BaseBuilder
extends Object

Contains all the logic for configuration but no actual configuration. This is an abstract class. If you want a custom configuration from scratch, it's best to subclass this class and provide configuration settings there, see SimpleBuilder for an example. You can also subclass SimpleBuilder and not have to start from scratch. These builders also come with a copy constructor making it easy to do mixins (last configuration setting wins).

Field Summary

Fields

Modifier and Type	Field	Description
Function<Config,ActorGroupAssigner>	actorGroupAssignerFn
BiFunction<Config,Integer,ActorGroup>	actorGroupFn
Function<Config,Integer>	actorGroupReplicasFn
Function<Config,Integer>	actorGroupsFn
Function<Config,Integer>	actorGroupThreadsFn
Function<Config,ActorIdFactory>	actorIdFactoryFn
Map<String,ActorMetadata>	actorMetadata
Function<Config,Integer>	backpressureLimitFn
Function<Config,Integer>	backpressureWaitMsFn
Function<Config,Clock>	clockFn
Function<Config,Coordinator>	coordinatorFn
Function<Config,Integer>	evictionFn
Function<Config,Host>	hostFn
Function<Config,Integer>	hostNumberFn
Function<Config,Message>	messageFn
Function<Config,MessageId>	messageIdFn
Function<Config,PersisterFactory>	persisterFactoryFn
Function<Config,Random>	randomFn
Function<Config,String>	rootDirectoryFn
BiFunction<Config,ActorGroup,Scheduler>	schedulerFn
Function<Config,SerializerFactory>	serializerFactoryFn
Function<Config,Integer>	shutdownWaitMsFn

Constructor Summary

Constructors

Constructor	Description
BaseBuilder()	Start with an empty builder
BaseBuilder(BaseBuilder from)	Copy constructor builder.

Method Summary

Modifier and Type	Method	Description
BaseBuilder	actorGroup(BiFunction<Config,Integer,ActorGroup> actorGroupFn)	Local factory
BaseBuilder	actorGroupAssigner(Function<Config,ActorGroupAssigner> actorGroupAssignerFn)	Local singleton
BaseBuilder	actorGroupReplicas(int actorGroupReplicas)	The number of replicas of a actorGroup to maintain.
BaseBuilder	actorGroupReplicas(Function<Config,Integer> actorGroupReplicasFn)
BaseBuilder	actorGroups(int actorGroups)	Specify the number of actorGroups in the system.
BaseBuilder	actorGroups(Function<Config,Integer> actorGroupsFn)
BaseBuilder	actorGroupThreads(int actorGroupThreads)	Local dynamic (maybe) Change effective in new actorGroups only
BaseBuilder	actorGroupThreads(Function<Config,Integer> actorGroupThreadsFn)
BaseBuilder	actorIdFactory(Function<Config,ActorIdFactory> actorIdFactoryFn)	Local factory
BaseBuilder	backpressureLimit(int backpressureLimit)
BaseBuilder	backpressureLimit(Function<Config,Integer> backpressureLimitFn)	Global dynamic
BaseBuilder	backpressureWaitMs(int backpressureWaitMs)	Specify the backpressure limit in an ActorGroup.
BaseBuilder	backpressureWaitMs(Function<Config,Integer> backpressureWaitMsFn)	Specify the backpressure limit in an ActorGroup.
Config	build()	Build the Config object
BaseBuilder	clock(Function<Config,Clock> clockFn)
BaseBuilder	coordinator(Function<Config,Coordinator> coordinatorFn)	Local singleton
BaseBuilder	eviction(int eviction)	Global dynamic
BaseBuilder	eviction(Function<Config,Integer> evictionFn)
BaseBuilder	host(Function<Config,Host> hostFn)	local singleton
BaseBuilder	hostNumber(int hostNumber)	Local Static
BaseBuilder	hostNumber(Function<Config,Integer> hostNumberFn)
BaseBuilder	message(Function<Config,Message> messageFn)
BaseBuilder	messageId(Function<Config,MessageId> messageIdFn)
BaseBuilder	persisterFactory(Function<Config,PersisterFactory> persisterFactoryFn)
BaseBuilder	property(String name, String value)	Set a system property
BaseBuilder	random(Function<Config,Random> randomFn)
BaseBuilder	registerActorsInPackage(String packageName)	global static
BaseBuilder	registerActorType(String actorType, Class<? extends Actor> type)	Register a new ActorType with a default constructor
BaseBuilder	registerActorType(String actorType, Class<? extends Actor> type, BiFunction<Config,ActorId,Actor> factory)	global static Explicitly register an actor type name to actor class.
BaseBuilder	rootDirectory(String rootDirectory)
BaseBuilder	rootDirectory(Function<Config,String> rootDirectoryFn)
BaseBuilder	scheduler(BiFunction<Config,ActorGroup,Scheduler> schedulerFn)	Local factory
BaseBuilder	serializerFactory(Function<Config,SerializerFactory> serializerFactoryFn)
BaseBuilder	shutdownWaitMs(int ms)
BaseBuilder	shutdownWaitMs(Function<Config,Integer> ms)	global dynamic

Methods inherited from class java.lang.Object

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

Field Details

hostNumberFn

public Function<Config,Integer> hostNumberFn

clockFn

public Function<Config,Clock> clockFn

randomFn

public Function<Config,Random> randomFn

rootDirectoryFn

public Function<Config,String> rootDirectoryFn

actorGroupsFn

public Function<Config,Integer> actorGroupsFn

actorGroupReplicasFn

public Function<Config,Integer> actorGroupReplicasFn

backpressureLimitFn

public Function<Config,Integer> backpressureLimitFn

backpressureWaitMsFn

public Function<Config,Integer> backpressureWaitMsFn

shutdownWaitMsFn

public Function<Config,Integer> shutdownWaitMsFn

evictionFn

public Function<Config,Integer> evictionFn

actorGroupThreadsFn

public Function<Config,Integer> actorGroupThreadsFn

actorGroupAssignerFn

public Function<Config,ActorGroupAssigner> actorGroupAssignerFn

schedulerFn

public BiFunction<Config,ActorGroup,Scheduler> schedulerFn

actorIdFactoryFn

public Function<Config,ActorIdFactory> actorIdFactoryFn

actorGroupFn

public BiFunction<Config,Integer,ActorGroup> actorGroupFn

coordinatorFn

public Function<Config,Coordinator> coordinatorFn

hostFn

public Function<Config,Host> hostFn

messageIdFn

public Function<Config,MessageId> messageIdFn

messageFn

public Function<Config,Message> messageFn

persisterFactoryFn

public Function<Config,PersisterFactory> persisterFactoryFn

serializerFactoryFn

public Function<Config,SerializerFactory> serializerFactoryFn

actorMetadata

public Map<String,ActorMetadata> actorMetadata

Constructor Details

BaseBuilder

public BaseBuilder()

Start with an empty builder

BaseBuilder

public BaseBuilder(BaseBuilder from)

Copy constructor builder. Any setting in the source (from) builder overrides this builder.

Method Details

hostNumber

public BaseBuilder hostNumber(int hostNumber)

Local Static

Parameters:

hostNumber -

Returns:

hostNumber

public BaseBuilder hostNumber(Function<Config,Integer> hostNumberFn)

clock

public BaseBuilder clock(Function<Config,Clock> clockFn)

random

public BaseBuilder random(Function<Config,Random> randomFn)

rootDirectory

public BaseBuilder rootDirectory(String rootDirectory)

rootDirectory

public BaseBuilder rootDirectory(Function<Config,String> rootDirectoryFn)

actorGroups

public BaseBuilder actorGroups(int actorGroups)

Specify the number of actorGroups in the system. Default is 1 Global Static

Parameters:

actorGroups -

Returns:

actorGroups

public BaseBuilder actorGroups(Function<Config,Integer> actorGroupsFn)

actorGroupReplicas

public BaseBuilder actorGroupReplicas(int actorGroupReplicas)

The number of replicas of a actorGroup to maintain. Zero is valid. It means that only a primary actorGroup exists. The default is zero.

Parameters:

actorGroupReplicas -

Returns:

actorGroupReplicas

public BaseBuilder actorGroupReplicas(Function<Config,Integer> actorGroupReplicasFn)

eviction

public BaseBuilder eviction(int eviction)

Global dynamic

This is the extra number of threads we add to allow that number of ActorEntry threads to be removed to make room for new messages. If this value is zero, it's very likely to cause a deadlock in the ActorGroup because there is more work to do but no Actors can be evicted in order to perform that work.

This number should be above 5 to improve performance. The less the number, the more often the eviction process has to begin.

Parameters:

eviction -

Returns:

eviction

public BaseBuilder eviction(Function<Config,Integer> evictionFn)

actorGroupThreads

public BaseBuilder actorGroupThreads(int actorGroupThreads)

Local dynamic (maybe) Change effective in new actorGroups only

Parameters:

actorGroupThreads -

Returns:

actorGroupThreads

public BaseBuilder actorGroupThreads(Function<Config,Integer> actorGroupThreadsFn)

backpressureLimit

public BaseBuilder backpressureLimit(Function<Config,Integer> backpressureLimitFn)

Global dynamic

Parameters:

backpressureLimitFn -

Returns:

backpressureLimit

public BaseBuilder backpressureLimit(int backpressureLimit)

backpressureWaitMs

public BaseBuilder backpressureWaitMs(Function<Config,Integer> backpressureWaitMsFn)

Specify the backpressure limit in an ActorGroup. When the number of in-flight messages exceeds this limit, inbound messages are blocked. Global dynamic

Parameters:

backpressureWaitMsFn -

Returns:

backpressureWaitMs

public BaseBuilder backpressureWaitMs(int backpressureWaitMs)

Specify the backpressure limit in an ActorGroup. When the number of in-flight messages exceeds this limit, inbound messages are blocked. Global static

Parameters:

backpressureWaitMs -

Returns:

actorGroupAssigner

public BaseBuilder actorGroupAssigner(Function<Config,ActorGroupAssigner> actorGroupAssignerFn)

Local singleton

Parameters:

actorGroupAssignerFn -

Returns:

messageId

public BaseBuilder messageId(Function<Config,MessageId> messageIdFn)

Parameters:

messageIdFn - A function that will return a MessageId

Returns:

persisterFactory

public BaseBuilder persisterFactory(Function<Config,PersisterFactory> persisterFactoryFn)

serializerFactory

public BaseBuilder serializerFactory(Function<Config,SerializerFactory> serializerFactoryFn)

message

public BaseBuilder message(Function<Config,Message> messageFn)

Parameters:

messageFn - A function that will return a new Message

Returns:

registerActorsInPackage

public BaseBuilder registerActorsInPackage(String packageName)

global static

Parameters:

packageName -

Returns:

registerActorType

public BaseBuilder registerActorType(String actorType,
 Class<? extends Actor> type,
 BiFunction<Config,ActorId,Actor> factory)

global static Explicitly register an actor type name to actor class. If the actor has an ActorType annotation, this registration is not needed. If this is called after the package containing the actor is registered, then this setting takes priority

Parameters:

actorType -

type -

Returns:

Builder object to allow chaining

registerActorType

public BaseBuilder registerActorType(String actorType,
 Class<? extends Actor> type)

Register a new ActorType with a default constructor

Parameters:

actorType -

type -

Returns:

shutdownWaitMs

public BaseBuilder shutdownWaitMs(Function<Config,Integer> ms)

global dynamic

Parameters:

ms -

Returns:

shutdownWaitMs

public BaseBuilder shutdownWaitMs(int ms)

coordinator

public BaseBuilder coordinator(Function<Config,Coordinator> coordinatorFn)

Local singleton

Parameters:

coordinatorFn -

Returns:

host

public BaseBuilder host(Function<Config,Host> hostFn)

local singleton

Parameters:

hostFn -

Returns:

scheduler

public BaseBuilder scheduler(BiFunction<Config,ActorGroup,Scheduler> schedulerFn)

Local factory

Parameters:

schedulerFn -

Returns:

actorIdFactory

public BaseBuilder actorIdFactory(Function<Config,ActorIdFactory> actorIdFactoryFn)

Local factory

Parameters:

actorIdFactoryFn -

Returns:

actorGroup

public BaseBuilder actorGroup(BiFunction<Config,Integer,ActorGroup> actorGroupFn)

Local factory

Parameters:

actorGroupFn -

Returns:

property

public BaseBuilder property(String name,
 String value)

Set a system property

Parameters:

name -

value -

Returns:

build

public Config build()

Build the Config object

Returns: