org.maestro.common.worker

Interface MaestroWorker

All Superinterfaces:

Runnable, TestDuration.TestProgress

All Known Subinterfaces:

MaestroReceiverWorker, MaestroSenderWorker

All Known Implementing Classes:

JMSReceiverWorker, JMSSenderWorker

public interface MaestroWorker
extends Runnable, TestDuration.TestProgress

A common interface for any type of Maestro worker.

Method Summary

Modifier and Type	Method and Description
void	fail(Exception exception) Stops the test execution with a failure condition (ie.: to fail due to external causes)
WorkerStateInfo	getWorkerState() Gets the current state of the worker
void	halt() Halt the daemons
boolean	isRunning() Checks whether the worker is in running state.
void	setWorkerNumber(int number) When multiple workers are involved, set the number of the worker
void	setWorkerOptions(WorkerOptions workerOptions) Sets the options for this worker
void	start() Starts the test
void	stop() Stops the test execution
default org.HdrHistogram.Histogram	takeLatenciesSnapshot(org.HdrHistogram.Histogram intervalHistogram) It is able to take a snapshot of the current recorder latencies.

Methods inherited from interface java.lang.Runnable

run

Methods inherited from interface org.maestro.common.duration.TestDuration.TestProgress

elapsedTime, messageCount, startedEpochMillis

Method Detail

isRunning

boolean isRunning()

Checks whether the worker is in running state.

Returns:

true if it is in running state or false otherwise

setWorkerOptions

void setWorkerOptions(WorkerOptions workerOptions)

Sets the options for this worker

Parameters:

workerOptions - the worker options to set

getWorkerState

WorkerStateInfo getWorkerState()

Gets the current state of the worker

Returns:

the current state of the worker

start

void start()

Starts the test

stop

void stop()

Stops the test execution

fail

void fail(Exception exception)

Stops the test execution with a failure condition (ie.: to fail due to external causes)

halt

void halt()

Halt the daemons

takeLatenciesSnapshot

default org.HdrHistogram.Histogram takeLatenciesSnapshot(org.HdrHistogram.Histogram intervalHistogram)

It is able to take a snapshot of the current recorder latencies.

Parameters:

intervalHistogram - the new histogram to be used to record latencies from now on

Returns:

the old latencies histogram or null if none has been recorded.

setWorkerNumber

void setWorkerNumber(int number)

When multiple workers are involved, set the number of the worker

Parameters:

number - the number of this worker