Package de.iip_ecosphere.platform.services.environment.services

Class FixedRateSource.FixedRateParams

java.lang.Object

de.iip_ecosphere.platform.services.environment.services.FixedRateSource.FixedRateParams

Direct Known Subclasses:

FixedRateSource.TransportFixedRateSource.TransportFixedRateParams

Enclosing class:

FixedRateSource<D>

public static class FixedRateSource.FixedRateParams
extends Object

A parameter/configuration object for the FixedRateSource.

Author:

Holger Eichelberger, SSE

Field Summary

Fields

Modifier and Type	Field	Description
private int	duration
private long	fixedDelay
private Supplier<String>	headlineSupplier
private long	maxMessagesPerPoll

Constructor Summary

Constructors

Constructor	Description
FixedRateParams(long fixedDelay, long maxMessagesPerPoll, int duration)	Creates a fixed rate parameters object.
FixedRateParams(long fixedDelay, long maxMessagesPerPoll, int duration, Supplier<String> headlineSupplier)	Creates a fixed rate parameters object.

Method Summary

Modifier and Type	Method	Description
int	getDuration()	Returns the overall duration of the run/experiment, i.e., when an auto-stop shall set in.
long	getFixedDelay()	Returns the fixed delay between two polls/ingestions.
(package private) Supplier<String>	getHeadlineSupplier()	Returns a supplier for a headline when starting the run/experiment.
long	getMaxMessagesPerPoll()	Returns the (maximum) number of messages per poll/ingestions.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

maxMessagesPerPoll

private long maxMessagesPerPoll

fixedDelay

private long fixedDelay

duration

private int duration

headlineSupplier

private Supplier<String> headlineSupplier

Constructor Details

FixedRateParams

public FixedRateParams(long fixedDelay,
 long maxMessagesPerPoll,
 int duration)

Creates a fixed rate parameters object.

Parameters:

fixedDelay - the fixed delay between two polls/ingestions in ms

maxMessagesPerPoll - the (maximum) number of messages per poll

duration - the overall duration of the run/experiment in ms

FixedRateParams

public FixedRateParams(long fixedDelay,
 long maxMessagesPerPoll,
 int duration,
 Supplier<String> headlineSupplier)

Creates a fixed rate parameters object.

Parameters:

fixedDelay - the fixed delay between two polls/ingestions in ms

maxMessagesPerPoll - the (maximum) number of messages per poll

duration - the overall duration of the run/experiment in ms

headlineSupplier - the headline text supplier, may be null

Method Details

getMaxMessagesPerPoll

public long getMaxMessagesPerPoll()

Returns the (maximum) number of messages per poll/ingestions.

Returns:

the (maximum) number of messages per poll

getFixedDelay

public long getFixedDelay()

Returns the fixed delay between two polls/ingestions.

Returns:

the fixed delay in ms

getDuration

public int getDuration()

Returns the overall duration of the run/experiment, i.e., when an auto-stop shall set in.

Returns:

the duration in ms

getHeadlineSupplier

Supplier<String> getHeadlineSupplier()

Returns a supplier for a headline when starting the run/experiment.

Returns:

the headline supplier, may be null