Class BackendListener

java.lang.Object
org.apache.jmeter.testelement.AbstractTestElement
org.apache.jmeter.visualizers.backend.BackendListener
All Implemented Interfaces:
Serializable, Cloneable, NoThreadClone, Searchable, Remoteable, SampleListener, org.apache.jmeter.testelement.TestElement, TestStateListener, Backend

Async Listener that delegates SampleResult handling to implementations of BackendListenerClient
Since:
2.13
See Also:
  • Field Details

  • Constructor Details

    • BackendListener

      public BackendListener()
      Create a BackendListener.
  • Method Details

    • clone

      public Object clone()
      Specified by:
      clone in interface org.apache.jmeter.testelement.TestElement
      Overrides:
      clone in class AbstractTestElement
    • sampleOccurred

      public void sampleOccurred(SampleEvent event)
      Description copied from interface: SampleListener
      A sample has started and stopped.
      Specified by:
      sampleOccurred in interface SampleListener
      Parameters:
      event - the SampleEvent that has occurred
    • testStarted

      public void testStarted()
      Description copied from interface: TestStateListener

      Called just before the start of the test from the main engine thread. This is before the test elements are cloned. Note that not all the test variables will have been set up at this point.

      N.B. testStarted() and testEnded() are called from different threads.

      Specified by:
      testStarted in interface TestStateListener
      See Also:
    • testStarted

      public void testStarted(String host)
      Description copied from interface: TestStateListener

      Called just before the start of the test from the main engine thread. This is before the test elements are cloned. Note that not all the test variables will have been set up at this point.

      N.B. testStarted() and testEnded() are called from different threads.

      Specified by:
      testStarted in interface TestStateListener
      Parameters:
      host - name of host
      See Also:
    • testEnded

      public void testEnded(String host)
      Method called at the end of the test. This is called only on one instance of BackendListener. This method will loop through all of the other BackendListenerClients which have been registered (automatically in the constructor) and notify them that the test has ended, allowing the BackendListenerClients to cleanup. Implements TestStateListener.testEnded(String)
      Specified by:
      testEnded in interface TestStateListener
      Parameters:
      host - name of host
      See Also:
    • testEnded

      public void testEnded()
      Description copied from interface: TestStateListener

      Called once for all threads after the end of a test. This will use the same element instances as at the start of the test.

      N.B. testStarted() and testEnded() are called from different threads.

      Specified by:
      testEnded in interface TestStateListener
      See Also:
    • sampleStarted

      public void sampleStarted(SampleEvent e)
      Description copied from interface: SampleListener
      A sample has started.
      Specified by:
      sampleStarted in interface SampleListener
      Parameters:
      e - the SampleEvent that has started
    • sampleStopped

      public void sampleStopped(SampleEvent e)
      Description copied from interface: SampleListener
      A sample has stopped.
      Specified by:
      sampleStopped in interface SampleListener
      Parameters:
      e - the SampleEvent that has stopped
    • setArguments

      public void setArguments(Arguments args)
      Set the arguments (parameters) for the BackendListenerClient to be executed with.
      Parameters:
      args - the new arguments. These replace any existing arguments.
    • getArguments

      public Arguments getArguments()
      Get the arguments (parameters) for the BackendListenerClient to be executed with.
      Returns:
      the arguments
    • setClassname

      public void setClassname(String classname)
      Sets the Classname of the BackendListenerClient object
      Parameters:
      classname - the new Classname value
    • getClassname

      public String getClassname()
      Gets the Classname of the BackendListenerClient object
      Returns:
      the Classname value
    • setQueueSize

      public void setQueueSize(String queueSize)
      Sets the queue size
      Parameters:
      queueSize - the size of the queue
    • getQueueSize

      public String getQueueSize()
      Gets the queue size
      Returns:
      int queueSize