io.netty.handler.traffic

Class TrafficCounter

java.lang.Object

io.netty.handler.traffic.TrafficCounter

public class TrafficCounter
extends Object

TrafficCounter is associated with AbstractTrafficShapingHandler.

A TrafficCounter counts the read and written bytes such that the AbstractTrafficShapingHandler can limit the traffic, globally or per channel.

It computes the statistics for both read and written every checkInterval, and calls back to its parent AbstractTrafficShapingHandler.doAccounting(io.netty.handler.traffic.TrafficCounter) method. If the checkInterval is set to 0, no accounting will be done and statistics will only be computed at each receive or write operation.

Constructor Summary

Constructors

Constructor and Description
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

Method Summary

Methods

Modifier and Type	Method and Description
long	checkInterval()
void	configure(long newcheckInterval) Change checkInterval between two computations in millisecond
long	cumulativeReadBytes()
long	cumulativeWrittenBytes()
long	currentReadBytes()
long	currentWrittenBytes()
long	lastCumulativeTime()
long	lastReadBytes()
long	lastReadThroughput()
long	lastTime()
long	lastWriteThroughput()
long	lastWrittenBytes()
String	name()
long	readTimeToWait(long size, long limitTraffic, long maxTime) Returns the time to wait (if any) for the given length message, using the given limitTraffic and the max wait time
void	resetCumulativeTime() Reset both read and written cumulative bytes counters and the associated time.
void	start() Start the monitoring process
void	stop() Stop the monitoring process
String	toString() String information
long	writeTimeToWait(long size, long limitTraffic, long maxTime) Returns the time to wait (if any) for the given length message, using the given limitTraffic and the max wait time

Methods inherited from class java.lang.Object

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

Constructor Detail

TrafficCounter

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 - the associated AbstractTrafficShapingHandler

executor - the underlying executor service for scheduling checks

name - the name given to this monitor

checkInterval - the checkInterval in millisecond between two computations

Method Detail

start

public void start()

Start the monitoring process

stop

public void stop()

Stop the monitoring process

configure

public void configure(long newcheckInterval)

Change checkInterval between two computations in millisecond

Parameters:

newcheckInterval - The new check interval (in milliseconds)

checkInterval

public long checkInterval()

Returns:

the current checkInterval between two computations of traffic counter in millisecond

lastReadThroughput

public long lastReadThroughput()

Returns:

the Read Throughput in bytes/s computes in the last check interval

lastWriteThroughput

public long lastWriteThroughput()

Returns:

the Write Throughput in bytes/s computes in the last check interval

lastReadBytes

public long lastReadBytes()

Returns:

the number of bytes read during the last check Interval

lastWrittenBytes

public long lastWrittenBytes()

Returns:

the number of bytes written during the last check Interval

currentReadBytes

public long currentReadBytes()

Returns:

the current number of bytes read since the last checkInterval

currentWrittenBytes

public long currentWrittenBytes()

Returns:

the current number of bytes written since the last check Interval

lastTime

public long lastTime()

Returns:

the Time in millisecond of the last check as of System.currentTimeMillis()

cumulativeWrittenBytes

public long cumulativeWrittenBytes()

Returns:

the cumulativeWrittenBytes

cumulativeReadBytes

public long cumulativeReadBytes()

Returns:

the cumulativeReadBytes

lastCumulativeTime

public long lastCumulativeTime()

Returns:

the lastCumulativeTime in millisecond as of System.currentTimeMillis() when the cumulative counters were reset to 0.

resetCumulativeTime

public void resetCumulativeTime()

Reset both read and written cumulative bytes counters and the associated time.

name

public String name()

Returns:

the name

readTimeToWait

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

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

Parameters:

size - the recv size

limitTraffic - the traffic limit in bytes per second

maxTime - the max time in ms to wait in case of excess of traffic

Returns:

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

writeTimeToWait

public long writeTimeToWait(long size,
                   long limitTraffic,
                   long maxTime)

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

Parameters:

size - the write size

limitTraffic - the traffic limit in bytes per second

maxTime - the max time in ms to wait in case of excess of traffic

Returns:

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

toString

public String toString()

String information

Overrides:

toString in class Object