Package io.hyperfoil.api.config

Class PhaseBuilder<PB extends PhaseBuilder<PB>>

java.lang.Object

io.hyperfoil.api.config.PhaseBuilder<PB>

Direct Known Subclasses:

PhaseBuilder.ClosedModel, PhaseBuilder.Noop, PhaseBuilder.OpenModel, PhaseBuilder.Sequentially

public abstract class PhaseBuilder<PB extends PhaseBuilder<PB>>
extends Object

The builder creates a matrix of phases (not just single phase); we allow multiple iterations of a phase (with increasing number of users) and multiple forks (different scenarios, but same configuration).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PhaseBuilder.Always
static class	PhaseBuilder.AtOnce
static class	PhaseBuilder.Catalog
static class	PhaseBuilder.ClosedModel<T extends PhaseBuilder.ClosedModel<T>>
static class	PhaseBuilder.ConstantRate
static class	PhaseBuilder.Noop
static class	PhaseBuilder.OpenModel<P extends PhaseBuilder<P>>
static class	PhaseBuilder.RampRate
static class	PhaseBuilder.Sequentially

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,List<SLABuilder<PB>>>	customSlas
protected long	duration
protected boolean	forceIterations
protected List<PhaseForkBuilder>	forks
protected boolean	isWarmup
protected long	maxDuration
protected int	maxIterations
protected final String	name
protected final BenchmarkBuilder	parent
protected Collection<PhaseReference>	startAfter
protected Collection<PhaseReference>	startAfterStrict
protected long	startTime
protected PhaseReferenceDelay	startWith
protected Collection<PhaseReference>	terminateAfterStrict

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PhaseBuilder(BenchmarkBuilder parent, String name)

Method Summary

Modifier and Type	Method	Description
Collection<Phase>	build(SerializableSupplier<Benchmark> benchmark, AtomicInteger idCounter)
protected Phase	buildPhase(SerializableSupplier<Benchmark> benchmark, int phaseId, int iteration, PhaseForkBuilder f)
protected abstract Model	createModel(int iteration, double weight)
SLABuilder<PB>	customSla(String metric)
PB	duration(long duration)
BenchmarkBuilder	endPhase()
PB	forceIterations(boolean force)
PhaseForkBuilder	fork(String name)
PB	isWarmup(boolean isWarmup)
PB	maxDuration(long maxDuration)
PB	maxIterations(int iterations)
String	name()
static Phase	noop(SerializableSupplier<Benchmark> benchmark, int id, int iteration, String iterationName, long duration, Collection<String> startAfter, Collection<String> startAfterStrict, Collection<String> terminateAfterStrict)
void	prepareBuild()
void	readCustomSlaFrom(PhaseBuilder<?> other)
void	readForksFrom(PhaseBuilder<?> other)
ScenarioBuilder	scenario()
protected PB	self()
PB	startAfter(PhaseReference phase)
PB	startAfter(String phase)
PB	startAfterStrict(PhaseReference phase)
PB	startAfterStrict(String phase)
PB	startTime(long startTime)
PB	startWith(PhaseReferenceDelay startWith)
PB	startWith(String phase)

Methods inherited from class java.lang.Object

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

Field Details

name

protected final String name

parent

protected final BenchmarkBuilder parent

startTime

protected long startTime

startAfter

protected Collection<PhaseReference> startAfter

startAfterStrict

protected Collection<PhaseReference> startAfterStrict

terminateAfterStrict

protected Collection<PhaseReference> terminateAfterStrict

duration

protected long duration

maxDuration

protected long maxDuration

maxIterations

protected int maxIterations

forceIterations

protected boolean forceIterations

forks

protected List<PhaseForkBuilder> forks

isWarmup

protected boolean isWarmup

customSlas

protected Map<String,List<SLABuilder<PB extends PhaseBuilder<PB>>>> customSlas

startWith

protected PhaseReferenceDelay startWith

Constructor Details

PhaseBuilder

protected PhaseBuilder(BenchmarkBuilder parent,
 String name)

Method Details

noop

public static Phase noop(SerializableSupplier<Benchmark> benchmark,
 int id,
 int iteration,
 String iterationName,
 long duration,
 Collection<String> startAfter,
 Collection<String> startAfterStrict,
 Collection<String> terminateAfterStrict)

endPhase

public BenchmarkBuilder endPhase()

name

public String name()

scenario

public ScenarioBuilder scenario()

self

protected PB self()

fork

public PhaseForkBuilder fork(String name)

startTime

public PB startTime(long startTime)

startAfter

public PB startAfter(String phase)

startAfter

public PB startAfter(PhaseReference phase)

startAfterStrict

public PB startAfterStrict(String phase)

startAfterStrict

public PB startAfterStrict(PhaseReference phase)

startWith

public PB startWith(String phase)

startWith

public PB startWith(PhaseReferenceDelay startWith)

duration

public PB duration(long duration)

maxDuration

public PB maxDuration(long maxDuration)

maxIterations

public PB maxIterations(int iterations)

prepareBuild

public void prepareBuild()

build

public Collection<Phase> build(SerializableSupplier<Benchmark> benchmark,
 AtomicInteger idCounter)

buildPhase

protected Phase buildPhase(SerializableSupplier<Benchmark> benchmark,
 int phaseId,
 int iteration,
 PhaseForkBuilder f)

readForksFrom

public void readForksFrom(PhaseBuilder<?> other)

readCustomSlaFrom

public void readCustomSlaFrom(PhaseBuilder<?> other)

forceIterations

public PB forceIterations(boolean force)

isWarmup

public PB isWarmup(boolean isWarmup)

customSla

public SLABuilder<PB> customSla(String metric)

createModel

protected abstract Model createModel(int iteration,
 double weight)