org.perfcake.message.receiver

Interface Receiver

All Known Implementing Classes:

AbstractAutoSpawnReceiver, AbstractReceiver, HttpReceiver

public interface Receiver

Represents a receiver for receiving messages from a separate message channel. All received messages are passed to the correlator which notifies the correct SenderTask. A receiver must start the defined (using the setThreads(int) method) threads to receive messages. These threads are later stopped with Thread.interrupt(). It is up to the receiver threads to react accordingly. Receivers must be executed as daemon threads and can be terminated at the end of the test execution if they do not react to the interruption.

Author:

Martin Večeřa

Method Summary

Modifier and Type	Method and Description
String	getSource() Gets the source from where to receive the messages.
Receiver	setCorrelator(Correlator correlator) Sets the correlator that will be handling the responses.
Receiver	setSource(String source) Sets the source from where to receive the messages.
Receiver	setThreads(int threadCount) Sets the number of threads that will be receiving responses.
void	start() Starts all receiver threads.
void	stop() Stops all the receiver threads.

Method Detail

setThreads

Receiver setThreads(int threadCount)

Sets the number of threads that will be receiving responses.

Parameters:

threadCount - The number of threads that will be receiving responses.

Returns:

Instance of this for fluent API.

setCorrelator

Receiver setCorrelator(Correlator correlator)

Sets the correlator that will be handling the responses.

Parameters:

correlator - The correlator that will be handling the responses.

Returns:

Instance of this for fluent API.

start

void start()
    throws PerfCakeException

Starts all receiver threads.

Throws:

PerfCakeException - When it was not possible to start all threads.

stop

void stop()

Stops all the receiver threads.

getSource

String getSource()

Gets the source from where to receive the messages.

Returns:

The current source (typically an URI).

setSource

Receiver setSource(String source)

Sets the source from where to receive the messages.

Parameters:

source - The source to be set.

Returns:

Instance of this for fluent API.