org.apache.jmeter.samplers

## Interface RemoteSampleListener

- All Superinterfaces:
    java.rmi.Remote
  All Known Implementing Classes:
    RemoteSampleListenerImpl

      public interface RemoteSampleListener
      extends java.rmi.Remote

  Allows notification on events occurring during the sampling process. Specifically, when sampling is started, when a specific sample is obtained, and when sampling is stopped.

- - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `processBatch(java.util.List<SampleEvent> samples)` This method is called remotely and fires a list of samples events received locally.
    `void` | `sampleOccurred(SampleEvent e)` A sample has started and stopped.
    `void` | `sampleStarted(SampleEvent e)` A sample has started.
    `void` | `sampleStopped(SampleEvent e)` A sample has stopped.
    `void` | `testEnded()`
    `void` | `testEnded(java.lang.String host)`
    `void` | `testStarted()`
    `void` | `testStarted(java.lang.String host)`

- - ### Method Detail

    - #### testStarted

          void testStarted()
                    throws java.rmi.RemoteException

      Throws:
        `java.rmi.RemoteException`

    - #### testStarted

          void testStarted(java.lang.String host)
                    throws java.rmi.RemoteException

      Throws:
        `java.rmi.RemoteException`

    - #### testEnded

          void testEnded()
                  throws java.rmi.RemoteException

      Throws:
        `java.rmi.RemoteException`

    - #### testEnded

          void testEnded(java.lang.String host)
                  throws java.rmi.RemoteException

      Throws:
        `java.rmi.RemoteException`

    - #### processBatch

          void processBatch(java.util.List<SampleEvent> samples)
                     throws java.rmi.RemoteException

      This method is called remotely and fires a list of samples events received locally. The function is to reduce network load when using remote testing.
      Parameters:
        `samples` - the list of sample events to be fired locally.
      Throws:
        `java.rmi.RemoteException` - when calling the remote method fails

    - #### sampleOccurred

          void sampleOccurred(SampleEvent e)
                       throws java.rmi.RemoteException

      A sample has started and stopped.
      Parameters:
        `e` - the event with data about the completed sample
      Throws:
        `java.rmi.RemoteException` - when calling the remote method fails

    - #### sampleStarted

          void sampleStarted(SampleEvent e)
                      throws java.rmi.RemoteException

      A sample has started.
      Parameters:
        `e` - the event with data about the started sample
      Throws:
        `java.rmi.RemoteException` - when calling the remote method fails

    - #### sampleStopped

          void sampleStopped(SampleEvent e)
                      throws java.rmi.RemoteException

      A sample has stopped.
      Parameters:
        `e` - the event with data about the stopped sample
      Throws:
        `java.rmi.RemoteException` - when calling the remote method fails

Copyright © 1998-2019 Apache Software Foundation. All Rights Reserved.