SampleTimeout (Apache JMeter API)

java.lang.Object
- org.apache.jmeter.testelement.AbstractTestElement
- - org.apache.jmeter.modifiers.SampleTimeout

All Implemented Interfaces:

Serializable, Cloneable, Searchable, SampleMonitor, TestElement, ThreadListener
```
public class SampleTimeout
extends AbstractTestElement
implements Serializable, ThreadListener, SampleMonitor
```
Sample timeout implementation using Executor threads

Since:

3.0

See Also:
Serialized Form

Field Summary
- Fields inherited from interface org.apache.jmeter.testelement.TestElement
  COMMENTS, ENABLED, GUI_CLASS, NAME, TEST_CLASS

Constructor Summary

Constructors
Constructor and Description

SampleTimeout()
No-arg constructor.

Constructors
Constructor and Description
`SampleTimeout()` No-arg constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`getTimeout()` Get the timeout value for display.
`void`	`sampleEnded(Sampler sampler)` A sample has just finished
`void`	`sampleStarting(Sampler sampler)` A sample is about to start
`void`	`setTimeout(String timeout)` Set the timeout for this timer.
`void`	`threadFinished()` Called for each thread after all samples have been processed.
`void`	`threadStarted()` Called for each thread before starting sampling.
`String`	`toString()` Provide a description of this class.

Methods inherited from class org.apache.jmeter.testelement.AbstractTestElement
addPropertiesValues, addProperty, addProperty, addTestElement, canRemove, clear, clearTemporary, clearTestElementChildren, clone, emptyTemporary, equals, getComment, getName, getProperty, getPropertyAsBoolean, getPropertyAsBoolean, getPropertyAsDouble, getPropertyAsFloat, getPropertyAsInt, getPropertyAsInt, getPropertyAsLong, getPropertyAsLong, getPropertyAsString, getPropertyAsString, getSearchableTokens, getThreadContext, getThreadName, hashCode, isEnabled, isRunningVersion, isTemporary, logProperties, mergeIn, propertyIterator, recoverRunningVersion, removeProperty, setComment, setEnabled, setName, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setRunningVersion, setTemporary, setThreadContext, setThreadName, traverse, traverseCollection, traverseMap, traverseProperty

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SampleTimeout
```
public SampleTimeout()
```
    No-arg constructor.
- Method Detail
  - setTimeout
```
public void setTimeout(String timeout)
```
    Set the timeout for this timer.
    
    Parameters:
    timeout - The timeout for this timer
  - getTimeout
```
public String getTimeout()
```
    Get the timeout value for display.
    
    Returns:
    the timeout value for display.
  - sampleStarting
```
public void sampleStarting(Sampler sampler)
```
    Description copied from interface: SampleMonitor
    
    A sample is about to start
    
    Specified by:
    
    sampleStarting in interface SampleMonitor
  - sampleEnded
```
public void sampleEnded(Sampler sampler)
```
    Description copied from interface: SampleMonitor
    
    A sample has just finished
    
    Specified by:
    
    sampleEnded in interface SampleMonitor
  - threadStarted
```
public void threadStarted()
```
    Description copied from interface: ThreadListener
    
    Called for each thread before starting sampling. WARNING: this is called before any Config test elements are processed, so any properties they define will not have been merged in yet.
    
    Specified by:
    
    threadStarted in interface ThreadListener
    
    See Also:
    JMeterThread.threadStarted()
  - threadFinished
```
public void threadFinished()
```
    Description copied from interface: ThreadListener
    
    Called for each thread after all samples have been processed.
    
    Specified by:
    
    threadFinished in interface ThreadListener
    
    See Also:
    JMeterThread.threadFinished(org.apache.jmeter.engine.event.LoopIterationListener)
  - toString
```
public String toString()
```
    Provide a description of this class.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    the description of this class.

Class SampleTimeout

Field Summary

Fields inherited from interface org.apache.jmeter.testelement.TestElement

Constructor Summary

Method Summary

Methods inherited from class org.apache.jmeter.testelement.AbstractTestElement

Methods inherited from class java.lang.Object

Constructor Detail

SampleTimeout

Method Detail

setTimeout

getTimeout

sampleStarting

sampleEnded

threadStarted

threadFinished

toString