Package io.hyperfoil.api.session

Interface Session

All Superinterfaces:

java.util.concurrent.Callable<java.lang.Void>

public interface Session
extends java.util.concurrent.Callable<java.lang.Void>

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Session.ConcurrencyPolicy	Behaviour when a new sequence start is requested but the concurrency factor is exceeded.
static interface	Session.Resource
static interface	Session.ResourceKey<R extends Session.Resource>
static interface	Session.Var
static class	Session.VarType

Method Summary

Modifier and Type	Method	Description
int	agentId()
int	agents()
int	agentThreadId()
int	agentThreads()
void	attach(io.netty.util.concurrent.EventExecutor executor, SharedData sharedData, SessionStatistics statistics)
Request	currentRequest()
void	currentRequest(Request request)
SequenceInstance	currentSequence()
void	currentSequence(SequenceInstance current)
<R extends Session.Resource> void	declareResource(Session.ResourceKey<R> key, java.util.function.Supplier<R> resourceSupplier)	See declareResource(ResourceKey, Supplier, boolean), with singleton defaulting to false
<R extends Session.Resource> void	declareResource(Session.ResourceKey<R> key, java.util.function.Supplier<R> resourceSupplier, boolean singleton)	Reserve space in the session for a resource, stored under given key.
<R extends Session.Resource> void	declareSingletonResource(Session.ResourceKey<R> key, R resource)
io.netty.util.concurrent.EventExecutor	executor()
void	fail(java.lang.Throwable t)
<R extends Session.Resource> R	getResource(Session.ResourceKey<R> key)
int	globalThreadId()
int	globalThreads()
boolean	isActive()
PhaseInstance	phase()
long	phaseStartTimestamp()
void	proceed()	Run anything that can be executed.
void	pruneStats(Phase phase)
void	reserve(Scenario scenario)
void	reset()
java.lang.String	runId()
SharedData	sharedData()
void	start(PhaseInstance phase)
SequenceInstance	startSequence(java.lang.String name, boolean forceSameIndex, Session.ConcurrencyPolicy policy)
Statistics	statistics(int stepId, java.lang.String name)
void	stop()
int	uniqueId()

Methods inherited from interface java.util.concurrent.Callable

call

Method Detail

reserve

void reserve(Scenario scenario)

uniqueId

int uniqueId()

Returns:

int >= 0 that's unique across whole simulation

agentThreadId

int agentThreadId()

agentThreads

int agentThreads()

globalThreadId

int globalThreadId()

globalThreads

int globalThreads()

agentId

int agentId()

agents

int agents()

runId

java.lang.String runId()

executor

io.netty.util.concurrent.EventExecutor executor()

sharedData

SharedData sharedData()

phase

PhaseInstance phase()

phaseStartTimestamp

long phaseStartTimestamp()

statistics

Statistics statistics(int stepId,
                      java.lang.String name)

pruneStats

void pruneStats(Phase phase)

declareResource

<R extends Session.Resource> void declareResource(Session.ResourceKey<R> key,
                                                  java.util.function.Supplier<R> resourceSupplier)

See declareResource(ResourceKey, Supplier, boolean), with singleton defaulting to false

Type Parameters:

R - Resource type.

Parameters:

key - Unique key (usually the step or handler itself)

resourceSupplier - Supplier creating the resource, possible multiple times.

declareResource

<R extends Session.Resource> void declareResource(Session.ResourceKey<R> key,
                                                  java.util.function.Supplier<R> resourceSupplier,
                                                  boolean singleton)

Reserve space in the session for a resource, stored under given key. If this is executed within a sequence with non-zero concurrency the session stores one resource for each concurrent instance. If this behaviour should be avoided set singleton to true.

Type Parameters:

R - Resource type.

Parameters:

key - Unique key (usually the step or handler itself)

resourceSupplier - Supplier creating the resource, possible multiple times.

singleton - Is the resource shared amongst concurrent sequences?

declareSingletonResource

<R extends Session.Resource> void declareSingletonResource(Session.ResourceKey<R> key,
                                                           R resource)

getResource

<R extends Session.Resource> R getResource(Session.ResourceKey<R> key)

currentSequence

void currentSequence(SequenceInstance current)

currentSequence

SequenceInstance currentSequence()

attach

void attach(io.netty.util.concurrent.EventExecutor executor,
            SharedData sharedData,
            SessionStatistics statistics)

start

void start(PhaseInstance phase)

proceed

void proceed()

Run anything that can be executed.

reset

void reset()

startSequence

SequenceInstance startSequence(java.lang.String name,
                               boolean forceSameIndex,
                               Session.ConcurrencyPolicy policy)

stop

void stop()

fail

void fail(java.lang.Throwable t)

isActive

boolean isActive()

currentRequest

Request currentRequest()

Returns:

Currently executed request, or null if not in scope.

currentRequest

void currentRequest(Request request)