forward.client
Class ForwardConnectionDescriptor

java.lang.Object
  extended by forward.client.ForwardConnectionDescriptor

public class ForwardConnectionDescriptor
extends java.lang.Object

This implements the forwarding information structure with supported mixcascades, quality of service parameters and the need for dummy traffic. This structure is just the information for the client. Every value is controlled by the forwarder, so changes don't have an effect to the forwarded connection.


Field Summary
private  int m_guaranteedBandwidth
          This stores the bandwidth (in bytes/second) guaranteed by the forwarder.
private  int m_maximumBandwidth
          This stores maximum bandwidth (in bytes/second) the forwarder supports.
private  int m_minDummyTrafficInterval
          This stores the minimal dummy traffic interval (in ms) for the forwarder.
private  java.util.Vector m_supportedMixCascades
          This stores the mixcascades supported by the forwarder.
 
Constructor Summary
ForwardConnectionDescriptor()
          This creates a new instance of ForwardConnectionDescriptor.
 
Method Summary
 void addMixCascade(MixCascade a_mixCascade)
          Adds a MixCascade to the list of mixcascades supported by the forwarder.
 int getGuaranteedBandwidth()
          Returns the guaranteed bandwidth (sum of upload and download in bytes/second) the forwarder supplies.
 int getMaximumBandwidth()
          Returns the maximum bandwidth (sum of upload and download in bytes/second) the forwarder supports.
 int getMinDummyTrafficInterval()
          Returns the dummy traffic interval (in ms) for the forwarder.
 java.util.Vector getMixCascadeList()
          Returns a snapshot of all supported mixcascades.
 void setGuaranteedBandwidth(int a_guaranteedBandwidth)
          Sets the guaranteed bandwidth (sum of upload and download in bytes/second) the forwarder supplies.
 void setMaximumBandwidth(int a_maximumBandwidth)
          Sets the maximum bandwidth (sum of upload and download in bytes/second) the forwarder supports.
 void setMinDummyTrafficInterval(int a_minDummyTrafficInterval)
          Sets the dummy traffic interval (in ms) for the forwarder.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

m_supportedMixCascades

private java.util.Vector m_supportedMixCascades
This stores the mixcascades supported by the forwarder.


m_maximumBandwidth

private int m_maximumBandwidth
This stores maximum bandwidth (in bytes/second) the forwarder supports. The sum of upload and download cannot be larger than that.


m_guaranteedBandwidth

private int m_guaranteedBandwidth
This stores the bandwidth (in bytes/second) guaranteed by the forwarder. We can send / receive data with at least that rate (sum of upload and download).


m_minDummyTrafficInterval

private int m_minDummyTrafficInterval
This stores the minimal dummy traffic interval (in ms) for the forwarder. We have to create dummy traffic with at least that rate. If this value is -1, the forwarder doesn't need dummy traffic.

Constructor Detail

ForwardConnectionDescriptor

public ForwardConnectionDescriptor()
This creates a new instance of ForwardConnectionDescriptor.

Method Detail

addMixCascade

public void addMixCascade(MixCascade a_mixCascade)
Adds a MixCascade to the list of mixcascades supported by the forwarder.

Parameters:
a_mixCascade - The MixCascade to add.

getMixCascadeList

public java.util.Vector getMixCascadeList()
Returns a snapshot of all supported mixcascades.

Returns:
A Vector with all mixcascades the forwarder supports.

setMaximumBandwidth

public void setMaximumBandwidth(int a_maximumBandwidth)
Sets the maximum bandwidth (sum of upload and download in bytes/second) the forwarder supports.

Parameters:
a_maximumBandwidth - The maximum bandwidth.

getMaximumBandwidth

public int getMaximumBandwidth()
Returns the maximum bandwidth (sum of upload and download in bytes/second) the forwarder supports.

Returns:
The maximum bandwidth.

setGuaranteedBandwidth

public void setGuaranteedBandwidth(int a_guaranteedBandwidth)
Sets the guaranteed bandwidth (sum of upload and download in bytes/second) the forwarder supplies.

Parameters:
a_guaranteedBandwidth - The guaranteed bandwidth.

getGuaranteedBandwidth

public int getGuaranteedBandwidth()
Returns the guaranteed bandwidth (sum of upload and download in bytes/second) the forwarder supplies.

Returns:
The guaranteed bandwidth.

setMinDummyTrafficInterval

public void setMinDummyTrafficInterval(int a_minDummyTrafficInterval)
Sets the dummy traffic interval (in ms) for the forwarder. We have to create dummy traffic with at least that rate. If this value is -1, the forwarder doesn't need dummy traffic.

Parameters:
a_minDummyTrafficInterval - The minimum dummy traffic interval.

getMinDummyTrafficInterval

public int getMinDummyTrafficInterval()
Returns the dummy traffic interval (in ms) for the forwarder. We have to create dummy traffic with at least that rate. If this value is -1, the forwarder doesn't need dummy traffic.

Returns:
The minimum dummy traffic interval.