org.thales.punch.libraries.netty.loadcontrol

Class LoadController

java.lang.Object

org.thales.punch.libraries.netty.loadcontrol.LoadController

All Implemented Interfaces:

ILoadController

Direct Known Subclasses:

RateLimiterLoadController

public class LoadController
extends Object
implements ILoadController

This class provides the factory to create Load Controllers, and also provides the default implementation that let all the traffic pass. It provides the base meters and logger facility. So that even with no Load control, each spout will publish useful metrics.

Author:

dimi

Field Summary

Fields

Modifier and Type	Field and Description
protected long	lastStatTimestamp
protected long	statsDelay

Constructor Summary

Constructors

Constructor and Description
LoadController(org.thales.punch.libraries.metrics.api.IMetricContext metricsContext) All load controller benefit from the pending metric, that reports the current number pf pending tuples in the topology.

Method Summary

Modifier and Type	Method and Description
void	ack(long v) update the controller statistics.
LoadController	configure(org.thales.punch.settings.api.ISettingsMap settings) Configure a load controller.
protected void	debug() dump some useful infos.
static LoadController	factory(org.thales.punch.settings.api.ISettingsMap settings, org.thales.punch.libraries.metrics.api.IMetricContext metricsContext) Return a load controller as configured in the settings.
void	fail(long v) update the controller statistics.
int	getCurrentRate()
void	regulate() regulate the traffic, this method potentially take some time before returning.
ILoadController	setMaxTimeoutSec(int v) Set the time considered as the maximum traversal time.

Methods inherited from class java.lang.Object

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

Field Detail

lastStatTimestamp

protected long lastStatTimestamp

statsDelay

protected long statsDelay

Constructor Detail

LoadController

public LoadController(org.thales.punch.libraries.metrics.api.IMetricContext metricsContext)

All load controller benefit from the pending metric, that reports the current number pf pending tuples in the topology. That meter is added to the per jvm reporter.

Parameters:

metricsContext - the metric context and registry provider

Method Detail

ack

public void ack(long v)

Description copied from interface: ILoadController

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

Specified by:

ack in interface ILoadController

Parameters:

v - the traversal time of a tuple, in milliseconds

fail

public void fail(long v)

Description copied from interface: ILoadController

update the controller statistics.

Specified by:

fail in interface ILoadController

Parameters:

v - the traversal time of a tuple, in milliseconds

setMaxTimeoutSec

public ILoadController setMaxTimeoutSec(int v)

Description copied from interface: ILoadController

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

Specified by:

setMaxTimeoutSec in interface ILoadController

Parameters:

v - the maximum traversal time

Returns:

this controller

regulate

public void regulate()

Description copied from interface: ILoadController

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

Specified by:

regulate in interface ILoadController

debug

protected void debug()

dump some useful infos.

configure

public LoadController configure(org.thales.punch.settings.api.ISettingsMap settings)

Configure a load controller. Each load controller implementation use various settings. Check the implementation you use.

Parameters:

settings - the caller load contraoller settings

Returns:

your rate controller

factory

public static LoadController factory(org.thales.punch.settings.api.ISettingsMap settings,
                                     org.thales.punch.libraries.metrics.api.IMetricContext metricsContext)

Return a load controller as configured in the settings. If no controller is configured, a no effect LoadController is returned.

Parameters:

settings - a settings map including a load controller configuration.

metricsContext - the IMetricContext to be used.

Returns:

the requested load controller

getCurrentRate

public int getCurrentRate()

Specified by:

getCurrentRate in interface ILoadController

Returns:

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