Netty/Handler 4.1.107.Final · io.netty.handler.traffic.TrafficCounter

Modifier and Type	Class and Description
private class	TrafficCounter.TrafficMonitoringTask Class to implement monitoring at fix delay

Field Summary

Modifier and Type	Field and Description
pack-priv final AtomicLong	checkInterval Delay between two captures
private final AtomicLong	cumulativeReadBytes Long life read bytes
private final AtomicLong	cumulativeWrittenBytes Long life written bytes
private final AtomicLong	currentReadBytes Current read bytes
private final AtomicLong	currentWrittenBytes Current written bytes
pack-priv final ScheduledExecutorService	executor Executor that will run the monitor
private long	lastCumulativeTime Last Time where cumulative bytes where reset to zero: this time is a real EPOC time (informative only)
private volatile long	lastReadBytes Last read bytes number during last check interval
private volatile long	lastReadingTime Last reading time during last check interval
private long	lastReadThroughput Last reading bandwidth
pack-priv final AtomicLong	lastTime Last Time Check taken
private long	lastWriteThroughput Last writing bandwidth
private volatile long	lastWritingTime Last future writing time during last check interval
private volatile long	lastWrittenBytes Last written bytes number during last check interval
private static final InternalLogger	logger
pack-priv Runnable	monitor Monitor created once in start()
pack-priv volatile boolean	monitorActive Is Monitor active
pack-priv final String	name Name of this Monitor
private long	readingTime Last reading delay during current check interval
private long	realWriteThroughput Real writing bandwidth
private final AtomicLong	realWrittenBytes Real written bytes
pack-priv volatile ScheduledFuture<?>	scheduledFuture used in stop() to cancel the timer
pack-priv final AbstractTrafficShapingHandler	trafficShapingHandler The associated TrafficShapingHandler
private long	writingTime Last writing time during current check interval

Constructor Summary

Access Constructor and Description

Access	Constructor and Description
public	TrafficCounter(ScheduledExecutorService the underlying executor service for scheduling checks, might be null when used from `GlobalChannelTrafficCounter`. executor, String the name given to this monitor. name, long the checkInterval in millisecond between two computations. checkInterval) Constructor with the `AbstractTrafficShapingHandler` that hosts it, the `ScheduledExecutorService` to use, its name, the checkInterval between two computations in milliseconds.
public	TrafficCounter(AbstractTrafficShapingHandler the associated AbstractTrafficShapingHandler. trafficShapingHandler, ScheduledExecutorService the underlying executor service for scheduling checks, might be null when used from `GlobalChannelTrafficCounter`. executor, String the name given to this monitor. name, long the checkInterval in millisecond between two computations. checkInterval) Constructor with the `AbstractTrafficShapingHandler` that hosts it, the Timer to use, its name, the checkInterval between two computations in millisecond.

public

TrafficCounter(ScheduledExecutorService

the underlying executor service for scheduling checks, might be null when used from GlobalChannelTrafficCounter.

executor, String

the name given to this monitor.

name, long

the checkInterval in millisecond between two computations.

checkInterval)

Constructor with the AbstractTrafficShapingHandler that hosts it, the ScheduledExecutorService to use, its name, the checkInterval between two computations in milliseconds.

public

TrafficCounter(AbstractTrafficShapingHandler

the associated AbstractTrafficShapingHandler.

trafficShapingHandler, ScheduledExecutorService

the underlying executor service for scheduling checks, might be null when used from GlobalChannelTrafficCounter.

executor, String

the name given to this monitor.

name, long

the checkInterval in millisecond between two computations.

checkInterval)

Constructor with the AbstractTrafficShapingHandler that hosts it, the Timer to use, its name, the checkInterval between two computations in millisecond.

Method Summary

Modifier and Type	Method and Description
pack-priv void	bytesRealWriteFlowControl(long the size in bytes to write write) Computes counters for Real Write.
pack-priv void	bytesRecvFlowControl(long the size in bytes to read recv) Computes counters for Read.
pack-priv void	bytesWriteFlowControl(long the size in bytes to write write) Computes counters for Write.
public long	Returns: the current checkInterval between two computations of traffic counter in millisecond. checkInterval()
public void	configure(long The new check interval (in milliseconds) newCheckInterval) Change checkInterval between two computations in millisecond.
public long	Returns: the cumulativeReadBytes cumulativeReadBytes()
public long	Returns: the cumulativeWrittenBytes cumulativeWrittenBytes()
public long	Returns: the current number of bytes read since the last checkInterval. currentReadBytes()
public long	Returns: the current number of bytes written since the last check Interval. currentWrittenBytes()
public long	Returns: the realWriteThroughput getRealWriteThroughput()
public AtomicLong	Returns: the realWrittenBytes getRealWrittenBytes()
private void	init(long checkInterval)
public long	Returns: the lastCumulativeTime in millisecond as of System.currentTimeMillis() when the cumulative counters were reset to 0. lastCumulativeTime()
public long	Returns: the number of bytes read during the last check Interval. lastReadBytes()
public long	Returns: the Read Throughput in bytes/s computes in the last check interval. lastReadThroughput()
public long	Returns: the Time in millisecond of the last check as of System.currentTimeMillis(). lastTime()
public long	Returns: the Write Throughput in bytes/s computes in the last check interval. lastWriteThroughput()
public long	Returns: the number of bytes written during the last check Interval. lastWrittenBytes()
public static long	Returns: the time in ms using nanoTime, so not real EPOCH time but elapsed time in ms. milliSecondFromNano()
public String	Returns: the name of this TrafficCounter. name()
public long	Returns: the current time to wait (in ms) if needed for Read operation. readTimeToWait(final long the recv size size, final long the traffic limit in bytes per second. limitTraffic, final long the max time in ms to wait in case of excess of traffic. maxTime) Deprecated Returns the time to wait (if any) for the given length message, using the given limitTraffic and the max wait time.
public long	Returns: the current time to wait (in ms) if needed for Read operation. readTimeToWait(final long the recv size size, final long the traffic limit in bytes per second limitTraffic, final long the max time in ms to wait in case of excess of traffic. maxTime, final long the current time now) Returns the time to wait (if any) for the given length message, using the given limitTraffic and the max wait time.
pack-priv synchronized void	resetAccounting(long the milliseconds unix timestamp that we should be considered up-to-date for. newLastTime) Reset the accounting on Read and Write.
public void	resetCumulativeTime() Reset both read and written cumulative bytes counters and the associated absolute time from System.currentTimeMillis().
public synchronized void	start() Start the monitoring process.
public synchronized void	stop() Stop the monitoring process.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public long	Returns: the current time to wait (in ms) if needed for Write operation. writeTimeToWait(final long the write size size, final long the traffic limit in bytes per second. limitTraffic, final long the max time in ms to wait in case of excess of traffic. maxTime) Deprecated Returns the time to wait (if any) for the given length message, using the given limitTraffic and the max wait time.
public long	Returns: the current time to wait (in ms) if needed for Write operation. writeTimeToWait(final long the write size size, final long the traffic limit in bytes per second. limitTraffic, final long the max time in ms to wait in case of excess of traffic. maxTime, final long the current time now) Returns the time to wait (if any) for the given length message, using the given limitTraffic and the max wait time.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

checkInterval	back to summary
pack-priv final AtomicLong checkInterval Delay between two captures

cumulativeReadBytes	back to summary
private final AtomicLong cumulativeReadBytes Long life read bytes

cumulativeWrittenBytes	back to summary
private final AtomicLong cumulativeWrittenBytes Long life written bytes

currentReadBytes	back to summary
private final AtomicLong currentReadBytes Current read bytes

currentWrittenBytes	back to summary
private final AtomicLong currentWrittenBytes Current written bytes

executor	back to summary
pack-priv final ScheduledExecutorService executor Executor that will run the monitor

lastCumulativeTime	back to summary
private long lastCumulativeTime Last Time where cumulative bytes where reset to zero: this time is a real EPOC time (informative only)

lastReadBytes	back to summary
private volatile long lastReadBytes Last read bytes number during last check interval

lastReadingTime	back to summary
private volatile long lastReadingTime Last reading time during last check interval

lastReadThroughput	back to summary
private long lastReadThroughput Last reading bandwidth

lastTime	back to summary
pack-priv final AtomicLong lastTime Last Time Check taken

lastWriteThroughput	back to summary
private long lastWriteThroughput Last writing bandwidth

lastWritingTime	back to summary
private volatile long lastWritingTime Last future writing time during last check interval

lastWrittenBytes	back to summary
private volatile long lastWrittenBytes Last written bytes number during last check interval

logger	back to summary
private static final InternalLogger logger

monitor	back to summary
pack-priv Runnable monitor Monitor created once in start()

monitorActive	back to summary
pack-priv volatile boolean monitorActive Is Monitor active

name	back to summary
pack-priv final String name Name of this Monitor

readingTime	back to summary
private long readingTime Last reading delay during current check interval

realWriteThroughput	back to summary
private long realWriteThroughput Real writing bandwidth

realWrittenBytes	back to summary
private final AtomicLong realWrittenBytes Real written bytes

scheduledFuture	back to summary
pack-priv volatile ScheduledFuture<?> scheduledFuture used in stop() to cancel the timer

trafficShapingHandler	back to summary
pack-priv final AbstractTrafficShapingHandler trafficShapingHandler The associated TrafficShapingHandler

writingTime	back to summary
private long writingTime Last writing time during current check interval

Constructor Detail

TrafficCounter back to summary

TrafficCounter	back to summary
public TrafficCounter(ScheduledExecutorService executor, String name, long checkInterval) Constructor with the `AbstractTrafficShapingHandler` that hosts it, the `ScheduledExecutorService` to use, its name, the checkInterval between two computations in milliseconds. Parameters executor:ScheduledExecutorService the underlying executor service for scheduling checks, might be null when used from `GlobalChannelTrafficCounter`. name:String the name given to this monitor. checkInterval:long the checkInterval in millisecond between two computations.

public TrafficCounter(ScheduledExecutorService executor, String name, long checkInterval)

Constructor with the AbstractTrafficShapingHandler that hosts it, the ScheduledExecutorService to use, its name, the checkInterval between two computations in milliseconds.

Parameters

executor:ScheduledExecutorService: the underlying executor service for scheduling checks, might be null when used from GlobalChannelTrafficCounter.
name:String: the name given to this monitor.
checkInterval:long: the checkInterval in millisecond between two computations.

TrafficCounter back to summary

TrafficCounter	back to summary
public TrafficCounter(AbstractTrafficShapingHandler trafficShapingHandler, ScheduledExecutorService executor, String name, long checkInterval) Constructor with the `AbstractTrafficShapingHandler` that hosts it, the Timer to use, its name, the checkInterval between two computations in millisecond. Parameters trafficShapingHandler:AbstractTrafficShapingHandler the associated AbstractTrafficShapingHandler. executor:ScheduledExecutorService the underlying executor service for scheduling checks, might be null when used from `GlobalChannelTrafficCounter`. name:String the name given to this monitor. checkInterval:long the checkInterval in millisecond between two computations.

public TrafficCounter(AbstractTrafficShapingHandler trafficShapingHandler, ScheduledExecutorService executor, String name, long checkInterval)

Constructor with the AbstractTrafficShapingHandler that hosts it, the Timer to use, its name, the checkInterval between two computations in millisecond.

Parameters

trafficShapingHandler:AbstractTrafficShapingHandler: the associated AbstractTrafficShapingHandler.
executor:ScheduledExecutorService: the underlying executor service for scheduling checks, might be null when used from GlobalChannelTrafficCounter.
name:String: the name given to this monitor.
checkInterval:long: the checkInterval in millisecond between two computations.

Method Detail

bytesRealWriteFlowControl	back to summary
pack-priv void bytesRealWriteFlowControl(long write) Computes counters for Real Write. Parameters write:long the size in bytes to write

bytesRealWriteFlowControl

back to summary

pack-priv void bytesRealWriteFlowControl(long write)

Computes counters for Real Write.

Parameters

write:long: the size in bytes to write

bytesRecvFlowControl	back to summary
pack-priv void bytesRecvFlowControl(long recv) Computes counters for Read. Parameters recv:long the size in bytes to read

bytesRecvFlowControl

back to summary

pack-priv void bytesRecvFlowControl(long recv)

Computes counters for Read.

Parameters

recv:long: the size in bytes to read

bytesWriteFlowControl	back to summary
pack-priv void bytesWriteFlowControl(long write) Computes counters for Write. Parameters write:long the size in bytes to write

bytesWriteFlowControl

back to summary

pack-priv void bytesWriteFlowControl(long write)

Computes counters for Write.

Parameters

write:long: the size in bytes to write

checkInterval	back to summary
public long checkInterval() Returns:long the current checkInterval between two computations of traffic counter in millisecond.

configure	back to summary
public void configure(long newCheckInterval) Change checkInterval between two computations in millisecond. Parameters newCheckInterval:long The new check interval (in milliseconds)

configure

back to summary

public void configure(long newCheckInterval)

Change checkInterval between two computations in millisecond.

Parameters

newCheckInterval:long: The new check interval (in milliseconds)

cumulativeReadBytes	back to summary
public long cumulativeReadBytes() Returns:long the cumulativeReadBytes

cumulativeWrittenBytes	back to summary
public long cumulativeWrittenBytes() Returns:long the cumulativeWrittenBytes

currentReadBytes	back to summary
public long currentReadBytes() Returns:long the current number of bytes read since the last checkInterval.

currentWrittenBytes	back to summary
public long currentWrittenBytes() Returns:long the current number of bytes written since the last check Interval.

getRealWriteThroughput	back to summary
public long getRealWriteThroughput() Returns:long the realWriteThroughput

getRealWrittenBytes	back to summary
public AtomicLong getRealWrittenBytes() Returns:AtomicLong the realWrittenBytes

init	back to summary
private void init(long checkInterval)

lastCumulativeTime	back to summary
public long lastCumulativeTime() Returns:long the lastCumulativeTime in millisecond as of System.currentTimeMillis() when the cumulative counters were reset to 0.

lastReadBytes	back to summary
public long lastReadBytes() Returns:long the number of bytes read during the last check Interval.

lastReadThroughput	back to summary
public long lastReadThroughput() Returns:long the Read Throughput in bytes/s computes in the last check interval.

lastTime	back to summary
public long lastTime() Returns:long the Time in millisecond of the last check as of System.currentTimeMillis().

lastWriteThroughput	back to summary
public long lastWriteThroughput() Returns:long the Write Throughput in bytes/s computes in the last check interval.

lastWrittenBytes	back to summary
public long lastWrittenBytes() Returns:long the number of bytes written during the last check Interval.

milliSecondFromNano	back to summary
public static long milliSecondFromNano() Returns:long the time in ms using nanoTime, so not real EPOCH time but elapsed time in ms.

name	back to summary
public String name() Returns:String the name of this TrafficCounter.

readTimeToWait

back to summary

public long readTimeToWait(final long size, final long limitTraffic, final long maxTime)

Deprecated

Returns the time to wait (if any) for the given length message, using the given limitTraffic and the max wait time.

Parameters

size:long: the recv size
limitTraffic:long: the traffic limit in bytes per second.
maxTime:long: the max time in ms to wait in case of excess of traffic.

Returns:long

the current time to wait (in ms) if needed for Read operation.

Annotations

@Deprecated

readTimeToWait

back to summary

public long readTimeToWait(final long size, final long limitTraffic, final long maxTime, final long now)

Returns the time to wait (if any) for the given length message, using the given limitTraffic and the max wait time.

Parameters

size:long: the recv size
limitTraffic:long: the traffic limit in bytes per second
maxTime:long: the max time in ms to wait in case of excess of traffic.
now:long: the current time

Returns:long

the current time to wait (in ms) if needed for Read operation.

resetAccounting

back to summary

pack-priv synchronized void resetAccounting(long newLastTime)

Reset the accounting on Read and Write.

Parameters

newLastTime:long: the milliseconds unix timestamp that we should be considered up-to-date for.

resetCumulativeTime	back to summary
public void resetCumulativeTime() Reset both read and written cumulative bytes counters and the associated absolute time from System.currentTimeMillis().