org.yardstickframework

Interface BenchmarkDriver

All Known Implementing Classes:

AtomicCounterBenchmark, BenchmarkDriverAdapter, EchoBenchmark

public interface BenchmarkDriver

Benchmark driver.

Method Summary

Methods

Modifier and Type	Method and Description
String	description() Gets benchmark description.
Collection<BenchmarkProbe>	probes() Gets collection of custom probes that this benchmark provides.
void	setUp(BenchmarkConfiguration cfg) This method is invoked right before the test() method.
void	tearDown() This method is invoked right after the test() method.
void	test() Operation or group of operations that are to be benchmarked.
String	usage() Gets benchmark usage.

Method Detail

setUp

void setUp(BenchmarkConfiguration cfg)
           throws Exception

This method is invoked right before the test() method. All benchmark preparation and all resource initialization should be done here.

Parameters:

cfg - Benchmark configuration.

Throws:

Exception - If failed.

test

void test()
          throws Exception

Operation or group of operations that are to be benchmarked.

Throws:

Exception - If failed.

tearDown

void tearDown()
              throws Exception

This method is invoked right after the test() method. All necessary resources should be released here.

Throws:

Exception - If failed.

probes

Collection<BenchmarkProbe> probes()

Gets collection of custom probes that this benchmark provides.

Returns:

Collection of custom probes or null if set of default probes should be used.

description

String description()

Gets benchmark description.

Returns:

Benchmark description.

usage

String usage()

Gets benchmark usage.

Returns:

Benchmark usage.