Package org.apache.jmeter.report.processor

Class TaggerConsumer

  • All Implemented Interfaces:
    org.apache.jmeter.report.processor.SampleConsumer , org.apache.jmeter.report.processor.SampleProcessor , org.apache.jmeter.report.processor.SampleProducer 
    
public class TaggerConsumer<TIndex>
extends AbstractSampleConsumer

    The Class TimeCountConsumer adds a data field to the samples it consumes. The new field is identified by the value of tagLabel in the sample metadata.

    Since:

    3.0

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Constructor Summary

      Constructors 
      Constructor Description
      TaggerConsumer()

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      final SampleIndexer<TIndex> getSampleIndexer()
      final void setSampleIndexer(SampleIndexer<TIndex> sampleIndexer)
      final String getTagLabel() Gets the label of the tag used by this consumer.
      final void setTagLabel(String tagLabel)
      void startConsuming() Start the sample consuming.
      void consume(Sample sample, int channel) Consumes the specified sample ton the specified channel.
      void stopConsuming() Stops the consuming process.

      • Methods inherited from class org.apache.jmeter.report.processor.AbstractSampleConsumer

        addSampleConsumer, getConsumedChannelCount, getConsumedMetadata, getName, getWorkingDirectory, produce, removeSampleConsumer, setChannelAttribute, setConsumedMetadata, 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

    • Constructor Detail

      • TaggerConsumer

        TaggerConsumer()

    • Method Detail

      • getTagLabel

         final String getTagLabel()

        Gets the label of the tag used by this consumer.

        Returns:

        the label of the tag used by this consumer.

      • startConsuming

         void startConsuming()

        Start the sample consuming. This step is used by consumer to initialize their process.

      • consume

         void consume(Sample sample, int channel)

        Consumes the specified sample ton the specified channel.

        Parameters:
        channel - The channel on which the sample is consumed

      • stopConsuming

         void stopConsuming()

        Stops the consuming process. No sample will be processed after this service has been called.