AggregateConsumer (Apache JMeter dist API)

https://jmeter.apache.org/api/org/apache/jmeter/report/processor/AggregateConsumer.html AggregateConsumer (Apache JMeter dist API)

java.lang.Object

org.apache.jmeter.report.processor.AbstractSampleProcessor

org.apache.jmeter.report.processor.AbstractSampleConsumer

org.apache.jmeter.report.processor.AggregateConsumer

All Implemented Interfaces:: SampleConsumer, SampleProcessor, SampleProducer

public class AggregateConsumer extends AbstractSampleConsumer

The Class AggregateConsumer provides a consumer that can aggregate samples to provide a result

Since:: 3.0

Constructor Summary

Constructors

Constructor

Description

AggregateConsumer(Aggregator aggregator, SampleSelector<Double> selector)

Instantiates a new abstract aggregate consumer.
Method Summary

Modifier and Type

Method

Description

void

consume(Sample sample, int channel)

Consumes the specified sample ton the specified channel.

final Aggregator

getAggregator()

Gets the aggregator.

final SampleSelector<Double>

getSelector()

Gets the selector.

void

startConsuming()

Start the sample consuming.

void

stopConsuming()

Stops the consuming process.

Methods inherited from class org.apache.jmeter.report.processor.AbstractSampleConsumer
addSampleConsumer, getConsumedChannelCount, getConsumedMetadata, getConsumer, getDataFromContext, getName, getWorkingDirectory, produce, removeSampleConsumer, setChannelAttribute, setConsumedMetadata, setDataToContext, setName, setProducedMetadata, setSampleConsumer, setSampleConsumers, setSampleContext, startProducing, stopProducing

Methods inherited from class org.apache.jmeter.report.processor.AbstractSampleProcessor
getChannelAttribute, getSampleContext

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.jmeter.report.processor.SampleProcessor
getChannelAttribute, getSampleContext

Constructor Details
- AggregateConsumer
  
  public AggregateConsumer(Aggregator aggregator, SampleSelector<Double> selector)
  
  Instantiates a new abstract aggregate consumer.
  
  Parameters:
  
  aggregator - the aggregator (must not be null)
  
  selector - the selector (must not be null)
Method Details
- getAggregator
  
  public final Aggregator getAggregator()
  
  Gets the aggregator.
  
  Returns:
  
  the aggregator
- getSelector
  
  public final SampleSelector<Double> getSelector()
  
  Gets the selector.
  
  Returns:
  
  the selector
- startConsuming
  
  public void startConsuming()
  
  Description copied from interface: SampleConsumer
  
  Start the sample consuming. This step is used by consumer to initialize their process.
- consume
  
  public void consume(Sample sample, int channel)
  
  Description copied from interface: SampleConsumer
  
  Consumes the specified sample ton the specified channel.
  
  Parameters:
  
  sample - The sample to be consumed
  
  channel - The channel on which the sample is consumed
- stopConsuming
  
  public void stopConsuming()
  
  Description copied from interface: SampleConsumer
  
  Stops the consuming process. No sample will be processed after this service has been called.