PayloadGeneratorInput (HiveMQ Swarm Extension SDK 4.7.2 API)

All Superinterfaces:: ExtensionInput, ExtensionTaskInput

public interface PayloadGeneratorInput
extends ExtensionTaskInput

Since:: 4.6.0

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`int`	`getClientOffset()`	The offset of the client within Range: [0..inf] of the client group this generator is associated with.
`long`	`getCount()`	The count of publish messages of the publish command.
`long`	`getRate()`	The rate of publish messages of the publish command.
`@NotNull String`	`getTopic()`	The topic of the publish which the payload is generated for.

Methods inherited from interface com.hivemq.swarm.extension.sdk.ExtensionInput
getScenarioDependencies

Methods inherited from interface com.hivemq.swarm.extension.sdk.ExtensionTaskInput
getAdditionalAttributes, getClientId

- Method Detail
  - getTopic
```
@NotNull
@NotNull String getTopic()
```
    The topic of the publish which the payload is generated for.
    
    Returns:
    
    the Topic.
    
    Since:
    
    4.6.0
  - getRate
```
long getRate()
```
    The rate of publish messages of the publish command. This is given as the interval between publishes in nanoseconds.
    
    Returns:
    
    the rate.
    
    Since:
    
    4.6.0
  - getCount
```
long getCount()
```
    The count of publish messages of the publish command.
    
    Returns:
    
    the count.
    
    Since:
    
    4.6.0
  - getClientOffset
```
int getClientOffset()
```
    The offset of the client within Range: [0..inf] of the client group this generator is associated with.
    
    Returns:
    
    Client offset
    
    Since:
    
    4.6.0