org.thales.punch.libraries.netty.loadcontrol

Interface ILoadController

All Known Implementing Classes:

LoadController, RateLimiterLoadController

public interface ILoadController

ILoadController allows you to regulate your data emitting to some fixed rate, or using an adaptative strategy should you need to slow down automatically in case the downstream latency increases.

The second strategy only works if you have some acknowledgement callback, telling you about the traversal time of the data. It can then be used to avoid overloading your processing path. A typical example of using this is inside a Storm topology.

It works as follows: whenever you want to accept a new incoming message in the system, you call the regulate() method. It will automatically slow down your processing rate. When a processed message is acknowledged,fully processed by the application, call the update method with the corresponding processing time in millisecond.

Author:

dimi

Method Summary

Modifier and Type	Method and Description
void	ack(long traversalTime) update the controller statistics.
void	fail(long traversalTime) update the controller statistics.
int	getCurrentRate()
void	regulate() regulate the traffic, this method potentially take some time before returning.
ILoadController	setMaxTimeoutSec(int maxTraversalTime) Set the time considered as the maximum traversal time.

Method Detail

ack

void ack(long traversalTime)

update the controller statistics. If you work with a non acknowledged protocol, call this method with a 0 value.

Parameters:

traversalTime - the traversal time of a tuple, in milliseconds

fail

void fail(long traversalTime)

update the controller statistics.

Parameters:

traversalTime - the traversal time of a tuple, in milliseconds

regulate

void regulate()

regulate the traffic, this method potentially take some time before returning. It will slow you down as requested by your settings.

setMaxTimeoutSec

ILoadController setMaxTimeoutSec(int maxTraversalTime)

Set the time considered as the maximum traversal time. This corresponds to the max topology tuple timeout.

Parameters:

maxTraversalTime - the maximum traversal time

Returns:

this controller

getCurrentRate

int getCurrentRate()

Returns:

the current limiting rate. If the rate limiter is configured as passing through ("none"), -1 is returned