Package com.microej.kf.util.control.net

Class Bandwidth

java.lang.Object

com.microej.kf.util.control.net.Bandwidth

public class Bandwidth
extends Object

Bandwidth representation with a maximum bytes to read and write per period.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Bandwidth.Period

Constructor Summary

Constructors

Constructor	Description
Bandwidth(Bandwidth.Period period, long maxBytesRead, long maxBytesWritten)	Creates a Bandwidth instance.

Method Summary

Modifier and Type	Method	Description
BandwidthChecker	getReadBandwidthChecker()	Read bandwidth getter.
BandwidthChecker	getWriteBandwidthChecker()	Write bandwidth getter.
String	toString()	Returns a string representation of the object.

Methods inherited from class java.lang.Object

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

Constructor Detail

Bandwidth

public Bandwidth(Bandwidth.Period period,
                 long maxBytesRead,
                 long maxBytesWritten)

Creates a Bandwidth instance.

Parameters:

period - the period over which the limit is applied.

maxBytesRead - the maximum number of bytes read per period. A negative value means there is no limit.

maxBytesWritten - the maximum number of bytes written per period. A negative value means there is no limit.

Method Detail

getReadBandwidthChecker

public BandwidthChecker getReadBandwidthChecker()

Read bandwidth getter.

Returns:

the bandwidth checker.

getWriteBandwidthChecker

public BandwidthChecker getWriteBandwidthChecker()

Write bandwidth getter.

Returns:

the bandwidth checker.

toString

public String toString()

Description copied from class: Object

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Overrides:

toString in class Object

Returns:

a string representation of the object.