DslBackendListener (jmeter-java-dsl 1.29 API)

java.lang.Object
- us.abstracta.jmeter.javadsl.core.testelements.BaseTestElement
- - us.abstracta.jmeter.javadsl.core.listeners.BaseListener
  - - us.abstracta.jmeter.javadsl.core.listeners.DslBackendListener<T>

All Implemented Interfaces:

DslTestElement, DslTestPlan.TestPlanChild, DslListener, BaseSampler.SamplerChild, MultiLevelTestElement, BaseThreadGroup.ThreadGroupChild

Direct Known Subclasses:

GraphiteBackendListener, InfluxDbBackendListener
```
public abstract class DslBackendListener<T extends DslBackendListener<T>>
extends BaseListener
```
Contains common logic used by test elements that use the backend listener.

Since:

0.20

Nested Class Summary

Nested Classes
Modifier and Type Class Description

protected static class DslBackendListener.BackendListenerCodeBuilder

Field Summary

Fields
Modifier and Type	Field	Description
`protected Class<? extends org.apache.jmeter.visualizers.backend.BackendListenerClient>`	`listenerClass`
`protected int`	`queueSize`
`protected String`	`url`

Fields inherited from class us.abstracta.jmeter.javadsl.core.testelements.BaseTestElement
guiClass, name

Constructor Summary

Constructors
Modifier	Constructor	Description
`protected`	`DslBackendListener(Class<? extends org.apache.jmeter.visualizers.backend.BackendListenerClient> listenerClass, String url)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected abstract org.apache.jmeter.config.Arguments`	`buildListenerArguments()`
`protected org.apache.jmeter.testelement.TestElement`	`buildTestElement()`
`T`	`queueSize(int queueSize)`	Specifies the length of sample results queue used to asynchronously send the information to the backend service.

Methods inherited from class us.abstracta.jmeter.javadsl.core.testelements.BaseTestElement
buildConfiguredTestElement, buildTestElementGui, buildTreeUnder, configureTestElement, durationToSeconds, loadBeanProperties, showAndWaitFrameWith, showFrameWith, showInGui, showTestElementGui

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

Methods inherited from interface us.abstracta.jmeter.javadsl.core.DslTestElement
buildTreeUnder, showInGui

- Field Detail
  - url
```
protected final String url
```
  - listenerClass
```
protected final Class<? extends org.apache.jmeter.visualizers.backend.BackendListenerClient> listenerClass
```
  - queueSize
```
protected int queueSize
```
- Constructor Detail
  - DslBackendListener
```
protected DslBackendListener(Class<? extends org.apache.jmeter.visualizers.backend.BackendListenerClient> listenerClass,
                             String url)
```
- Method Detail
  - queueSize
```
public T queueSize(int queueSize)
```
    Specifies the length of sample results queue used to asynchronously send the information to the backend service.
    When the queue reaches this limit, then the test plan execution will be affected since sample results will get blocked until there is space in the queue, affecting the general execution of the test plan and in consequence collected metrics.
    When not specified, this value defaults to 5000.
    
    Parameters:
    
    queueSize - the size of the queue to use.
    
    Returns:
    
    the listener for further configuration or usage.
  - buildTestElement
```
protected org.apache.jmeter.testelement.TestElement buildTestElement()
```
    Specified by:
    
    buildTestElement in class BaseTestElement
  - buildListenerArguments
```
protected abstract org.apache.jmeter.config.Arguments buildListenerArguments()
```