org.virtualbox_4_3
Class IBandwidthControl

java.lang.Object
  extended by org.virtualbox_4_3.IUnknown
      extended by org.virtualbox_4_3.IBandwidthControl

public class IBandwidthControl
extends IUnknown

Controls the bandwidth groups of one machine used to cap I/O done by a VM. This includes network and disk I/O. Interface ID: {E2EB3930-D2F4-4F87-BE17-0707E30F019F}


Field Summary
 
Fields inherited from class org.virtualbox_4_3.IUnknown
obj, port
 
Constructor Summary
IBandwidthControl(java.lang.String wrapped, org.virtualbox_4_3.jaxws.VboxPortType port)
           
 
Method Summary
 void createBandwidthGroup(java.lang.String name, BandwidthGroupType type, java.lang.Long maxBytesPerSec)
          Creates a new bandwidth group.
 void deleteBandwidthGroup(java.lang.String name)
          Deletes a new bandwidth group.
 java.util.List<IBandwidthGroup> getAllBandwidthGroups()
          Get all managed bandwidth groups.
 IBandwidthGroup getBandwidthGroup(java.lang.String name)
          Get a bandwidth group by name.
 java.lang.Long getNumGroups()
          The current number of existing bandwidth groups managed.
static IBandwidthControl queryInterface(IUnknown obj)
           
 
Methods inherited from class org.virtualbox_4_3.IUnknown
getRemoteWSPort, getWrapped, releaseRemote
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IBandwidthControl

public IBandwidthControl(java.lang.String wrapped,
                         org.virtualbox_4_3.jaxws.VboxPortType port)
Method Detail

getNumGroups

public java.lang.Long getNumGroups()
The current number of existing bandwidth groups managed.

Returns:
Long

queryInterface

public static IBandwidthControl queryInterface(IUnknown obj)

createBandwidthGroup

public void createBandwidthGroup(java.lang.String name,
                                 BandwidthGroupType type,
                                 java.lang.Long maxBytesPerSec)
Creates a new bandwidth group.

Parameters:
name - Name of the bandwidth group.
type - The type of the bandwidth group (network or disk).
maxBytesPerSec - The maximum number of bytes which can be transfered by all entities attached to this group during one second.

deleteBandwidthGroup

public void deleteBandwidthGroup(java.lang.String name)
Deletes a new bandwidth group.

Parameters:
name - Name of the bandwidth group to delete.

getBandwidthGroup

public IBandwidthGroup getBandwidthGroup(java.lang.String name)
Get a bandwidth group by name.

Parameters:
name - Name of the bandwidth group to get.
Returns:
Where to store the bandwidth group on success.

getAllBandwidthGroups

public java.util.List<IBandwidthGroup> getAllBandwidthGroups()
Get all managed bandwidth groups.

Returns:
The array of managed bandwidth groups.