VirtualBox Main API
Public Member Functions | Public Attributes | List of all members
IBandwidthControl Interface Reference

Controls the bandwidth groups of one machine used to cap I/O done by a VM. More...

Inheritance diagram for IBandwidthControl:

Public Member Functions

void createBandwidthGroup (in wstring name, in BandwidthGroupType type, in long long maxBytesPerSec)
 Creates a new bandwidth group. More...
 
void deleteBandwidthGroup (in wstring name)
 Deletes a new bandwidth group. More...
 
void getBandwidthGroup (in wstring name, [retval] out IBandwidthGroup bandwidthGroup)
 Get a bandwidth group by name. More...
 
void getAllBandwidthGroups ([retval] out IBandwidthGroup[] bandwidthGroups)
 Get all managed bandwidth groups. More...
 

Public Attributes

readonly attribute unsigned long numGroups
 The current number of existing bandwidth groups managed. More...
 

Detailed Description

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:
{48C7F4C0-C9D6-4742-957C-A6FD52E8C4AE}

Member Function Documentation

void IBandwidthControl::createBandwidthGroup ( in wstring  name,
in BandwidthGroupType  type,
in long long  maxBytesPerSec 
)

Creates a new bandwidth group.

Parameters
nameName of the bandwidth group.
typeThe type of the bandwidth group (network or disk).
maxBytesPerSecThe maximum number of bytes which can be transfered by all entities attached to this group during one second.
void IBandwidthControl::deleteBandwidthGroup ( in wstring  name)

Deletes a new bandwidth group.

Parameters
nameName of the bandwidth group to delete.
void IBandwidthControl::getBandwidthGroup ( in wstring  name,
[retval] out IBandwidthGroup  bandwidthGroup 
)

Get a bandwidth group by name.

Parameters
nameName of the bandwidth group to get.
bandwidthGroupWhere to store the bandwidth group on success.
void IBandwidthControl::getAllBandwidthGroups ( [retval] out IBandwidthGroup[]  bandwidthGroups)

Get all managed bandwidth groups.

Parameters
bandwidthGroupsThe array of managed bandwidth groups.

Member Data Documentation

readonly attribute unsigned long IBandwidthControl::numGroups

The current number of existing bandwidth groups managed.