io.scalecube.benchmarks

Class BenchmarksState<SELF extends BenchmarksState<SELF>>

java.lang.Object

io.scalecube.benchmarks.BenchmarksState<SELF>

Type Parameters:

SELF - when extending this class, please add your class as the SELF. ie.

    
  public class ExampleBenchmarksState extends BenchmarksState<ExampleBenchmarksState> {   
    ...   
  }   
 
        

public class BenchmarksState<SELF extends BenchmarksState<SELF>>
extends Object

BenchmarksState is the state of the benchmark. it gives you the analogy of the beginning, and ending of the test. It can run both sync or async way using the runForSync(Function) and runForAsync(Function) respectively.

Field Summary

Fields

Modifier and Type	Field and Description
protected BenchmarksSettings	settings

Constructor Summary

Constructors

Constructor and Description
BenchmarksState(BenchmarksSettings settings)

Method Summary

Modifier and Type	Method and Description
protected void	afterAll()
protected void	beforeAll()
com.codahale.metrics.Histogram	histogram(String name) Returns histogram with specified name.
com.codahale.metrics.Meter	meter(String name) Returns meter with specified name.
void	runForAsync(Function<SELF,Function<Long,org.reactivestreams.Publisher<?>>> func) Runs given function on this state.
void	runForSync(Function<SELF,Function<Long,Object>> func) Runs given function in the state.
reactor.core.scheduler.Scheduler	scheduler()
void	shutdown() Executes shutdown process of the state, also it includes running of afterAll().
void	start() Executes starting of the state, also it includes running of beforeAll().
com.codahale.metrics.Timer	timer(String name) Returns timer with specified name.

Methods inherited from class java.lang.Object

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

Field Detail

settings

protected final BenchmarksSettings settings

Constructor Detail

BenchmarksState

public BenchmarksState(BenchmarksSettings settings)

Method Detail

beforeAll

protected void beforeAll()

afterAll

protected void afterAll()

start

public final void start()

Executes starting of the state, also it includes running of beforeAll().

shutdown

public final void shutdown()

Executes shutdown process of the state, also it includes running of afterAll().

scheduler

public reactor.core.scheduler.Scheduler scheduler()

timer

public com.codahale.metrics.Timer timer(String name)

Returns timer with specified name.

Parameters:

name - name

Returns:

timer with specified name

meter

public com.codahale.metrics.Meter meter(String name)

Returns meter with specified name.

Parameters:

name - name

Returns:

meter with specified name

histogram

public com.codahale.metrics.Histogram histogram(String name)

Returns histogram with specified name.

Parameters:

name - name

Returns:

histogram with specified name

runForSync

public final void runForSync(Function<SELF,Function<Long,Object>> func)

Runs given function in the state. It also executes start() before and shutdown() after.

NOTICE: It's only for synchronous code.

Parameters:

func - a function that should return the execution to be tested for the given SELF. This execution would run on all positive values of Long (i.e. the benchmark itself) the return value is ignored.

runForAsync

public final void runForAsync(Function<SELF,Function<Long,org.reactivestreams.Publisher<?>>> func)

Runs given function on this state. It also executes start() before and shutdown() after.

NOTICE: It's only for asynchronous code.

Parameters:

func - a function that should return the execution to be tested for the given SELF. This execution would run on all positive values of Long (i.e. the benchmark itself) On the return value, as it is a Publisher, The benchmark test would subscribe, And upon all subscriptions - await for termination.