io.hyperfoil.api.config

Class PhaseBuilder<PB extends PhaseBuilder>

java.lang.Object

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

Direct Known Subclasses:

PhaseBuilder.Always, PhaseBuilder.AtOnce, PhaseBuilder.ConstantPerSec, PhaseBuilder.RampPerSec, PhaseBuilder.Sequentially

public abstract class PhaseBuilder<PB extends PhaseBuilder>
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 and Description
static class	PhaseBuilder.Always
static class	PhaseBuilder.AtOnce
static class	PhaseBuilder.Catalog
static class	PhaseBuilder.ConstantPerSec
static class	PhaseBuilder.RampPerSec
static class	PhaseBuilder.Sequentially

Field Summary

Fields

Modifier and Type	Field and Description
protected long	duration
protected List<PhaseForkBuilder>	forks
protected long	maxDuration
protected int	maxIterations
protected int	maxUnfinishedSessions
protected String	name
protected BenchmarkBuilder	parent
protected Collection<PhaseReference>	startAfter
protected Collection<PhaseReference>	startAfterStrict
protected long	startTime
protected Collection<PhaseReference>	terminateAfterStrict

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Collection<Phase>	build(SerializableSupplier<Benchmark> benchmark, AtomicInteger idCounter)
protected abstract Phase	buildPhase(SerializableSupplier<Benchmark> benchmark, SerializableSupplier<Phase> ps, int phaseId, int iteration, PhaseForkBuilder f)
PB	duration(long duration)
PB	duration(String duration)
BenchmarkBuilder	endPhase()
PhaseForkBuilder	fork(String name)
PB	maxDuration(long maxDuration)
PB	maxDuration(String duration)
PB	maxIterations(int iterations)
PB	maxUnfinishedSessions(int maxUnfinishedSessions)
String	name()
static Phase.Noop	noop(SerializableSupplier<Benchmark> benchmark, int id, String iterationName, List<String> startAfter, List<String> startAfterStrict, List<String> terminateAfterStrict)
void	prepareBuild()
void	readForksFrom(PhaseBuilder<?> other)
ScenarioBuilder	scenario()
PB	startAfter(PhaseReference phase)
PB	startAfter(String phase)
PB	startAfterStrict(PhaseReference phase)
PB	startAfterStrict(String phase)
PB	startTime(long startTime)
PB	startTime(String startTime)

Methods inherited from class java.lang.Object

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

Field Detail

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

maxUnfinishedSessions

protected int maxUnfinishedSessions

maxIterations

protected int maxIterations

forks

protected List<PhaseForkBuilder> forks

Constructor Detail

PhaseBuilder

protected PhaseBuilder(BenchmarkBuilder parent,
                       String name)

Method Detail

noop

public static Phase.Noop noop(SerializableSupplier<Benchmark> benchmark,
                              int id,
                              String iterationName,
                              List<String> startAfter,
                              List<String> startAfterStrict,
                              List<String> terminateAfterStrict)

endPhase

public BenchmarkBuilder endPhase()

name

public String name()

scenario

public ScenarioBuilder scenario()

fork

public PhaseForkBuilder fork(String name)

startTime

public PB startTime(long startTime)

startTime

public PB startTime(String 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)

duration

public PB duration(long duration)

duration

public PB duration(String duration)

maxDuration

public PB maxDuration(long maxDuration)

maxDuration

public PB maxDuration(String duration)

maxUnfinishedSessions

public PB maxUnfinishedSessions(int maxUnfinishedSessions)

maxIterations

public PB maxIterations(int iterations)

prepareBuild

public void prepareBuild()

build

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

buildPhase

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

readForksFrom

public void readForksFrom(PhaseBuilder<?> other)