VirtualBox Main API
Public Member Functions | List of all members
IInternalMachineControl Interface Reference
Inheritance diagram for IInternalMachineControl:

Public Member Functions

void updateState (in MachineState state)
 Updates the VM state. More...
 
void beginPowerUp (in IProgress progress)
 Tells VBoxSVC that IConsole::powerUp is under ways and gives it the progress object that should be part of any pending IMachine::launchVMProcess operations. More...
 
void endPowerUp (in long result)
 Tells VBoxSVC that IConsole::powerUp has completed. More...
 
void beginPoweringDown (out IProgress progress)
 Called by the VM process to inform the server it wants to stop the VM execution and power down. More...
 
void endPoweringDown (in long result, in wstring errMsg)
 Called by the VM process to inform the server that powering down previously requested by beginPoweringDown is either successfully finished or there was a failure. More...
 
void runUSBDeviceFilters (in IUSBDevice device, out boolean matched, out unsigned long maskedInterfaces)
 Asks the server to run USB devices filters of the associated machine against the given USB device and tell if there is a match. More...
 
void captureUSBDevice (in wstringUUID id, in wstring captureFilename)
 Requests a capture of the given host USB device. More...
 
void detachUSBDevice (in wstringUUID id, in boolean done)
 Notification that a VM is going to detach (done = false) or has already detached (done = true) the given USB device. More...
 
void autoCaptureUSBDevices ()
 Requests a capture all matching USB devices attached to the host. More...
 
void detachAllUSBDevices (in boolean done)
 Notification that a VM that is being powered down. More...
 
void onSessionEnd (in ISession session, [retval] out IProgress progress)
 Triggered by the given session object when the session is about to close normally. More...
 
void finishOnlineMergeMedium ()
 Gets called by IInternalSessionControl::onlineMergeMedium. More...
 
void pullGuestProperties (out wstring[] names, out wstring[] values, out long long[] timestamps, out wstring[] flags)
 Get the list of the guest properties matching a set of patterns along with their values, time stamps and flags and give responsibility for managing properties to the console. More...
 
void pushGuestProperty (in wstring name, in wstring value, in long long timestamp, in wstring flags)
 Update a single guest property in IMachine. More...
 
void lockMedia ()
 Locks all media attached to the machine for writing and parents of attached differencing media (if any) for reading. More...
 
void unlockMedia ()
 Unlocks all media previously locked using IInternalMachineControl::lockMedia. More...
 
void ejectMedium (in IMediumAttachment attachment, [retval] out IMediumAttachment newAttachment)
 Tells VBoxSVC that the guest has ejected the medium associated with the medium attachment. More...
 
void reportVmStatistics (in unsigned long validStats, in unsigned long cpuUser, in unsigned long cpuKernel, in unsigned long cpuIdle, in unsigned long memTotal, in unsigned long memFree, in unsigned long memBalloon, in unsigned long memShared, in unsigned long memCache, in unsigned long pagedTotal, in unsigned long memAllocTotal, in unsigned long memFreeTotal, in unsigned long memBalloonTotal, in unsigned long memSharedTotal, in unsigned long vmNetRx, in unsigned long vmNetTx)
 Passes statistics collected by VM (including guest statistics) to VBoxSVC. More...
 

Member Function Documentation

void IInternalMachineControl::updateState ( in MachineState  state)

Updates the VM state.

Note
This operation will also update the settings file with the correct information about the saved state file and delete this file from disk when appropriate.
void IInternalMachineControl::beginPowerUp ( in IProgress  progress)

Tells VBoxSVC that IConsole::powerUp is under ways and gives it the progress object that should be part of any pending IMachine::launchVMProcess operations.

The progress object may be called back to reflect an early cancelation, so some care have to be taken with respect to any cancelation callbacks. The console object will call IInternalMachineControl::endPowerUp to signal the completion of the progress object.

void IInternalMachineControl::endPowerUp ( in long  result)

Tells VBoxSVC that IConsole::powerUp has completed.

This method may query status information from the progress object it received in IInternalMachineControl::beginPowerUp and copy it over to any in-progress IMachine::launchVMProcess call in order to complete that progress object.

void IInternalMachineControl::beginPoweringDown ( out IProgress  progress)

Called by the VM process to inform the server it wants to stop the VM execution and power down.

Parameters
progressProgress object created by VBoxSVC to wait until the VM is powered down.
void IInternalMachineControl::endPoweringDown ( in long  result,
in wstring  errMsg 
)

Called by the VM process to inform the server that powering down previously requested by beginPoweringDown is either successfully finished or there was a failure.

Parameters
resultS_OK to indicate success.
errMsghuman readable error message in case of failure.
Expected result codes:
VBOX_E_FILE_ERROR Settings file not accessible.
VBOX_E_XML_ERROR Could not parse the settings file.
void IInternalMachineControl::runUSBDeviceFilters ( in IUSBDevice  device,
out boolean  matched,
out unsigned long  maskedInterfaces 
)

Asks the server to run USB devices filters of the associated machine against the given USB device and tell if there is a match.

Note
Intended to be used only for remote USB devices. Local ones don't require to call this method (this is done implicitly by the Host and USBProxyService).
void IInternalMachineControl::captureUSBDevice ( in wstringUUID  id,
in wstring  captureFilename 
)

Requests a capture of the given host USB device.

When the request is completed, the VM process will get a IInternalSessionControl::onUSBDeviceAttach notification.

void IInternalMachineControl::detachUSBDevice ( in wstringUUID  id,
in boolean  done 
)

Notification that a VM is going to detach (done = false) or has already detached (done = true) the given USB device.

When the done = true request is completed, the VM process will get a IInternalSessionControl::onUSBDeviceDetach notification.

Note
In the done = true case, the server must run its own filters and filters of all VMs but this one on the detached device as if it were just attached to the host computer.
void IInternalMachineControl::autoCaptureUSBDevices ( )

Requests a capture all matching USB devices attached to the host.

When the request is completed, the VM process will get a IInternalSessionControl::onUSBDeviceAttach notification per every captured device.

void IInternalMachineControl::detachAllUSBDevices ( in boolean  done)

Notification that a VM that is being powered down.

The done parameter indicates whether which stage of the power down we're at. When done = false the VM is announcing its intentions, while when done = true the VM is reporting what it has done.

Note
In the done = true case, the server must run its own filters and filters of all VMs but this one on all detach devices as if they were just attached to the host computer.
void IInternalMachineControl::onSessionEnd ( in ISession  session,
[retval] out IProgress  progress 
)

Triggered by the given session object when the session is about to close normally.

Parameters
sessionSession that is being closed
progressUsed to wait until the corresponding machine is actually dissociated from the given session on the server. Returned only when this session is a direct one.
void IInternalMachineControl::finishOnlineMergeMedium ( )

Gets called by IInternalSessionControl::onlineMergeMedium.

All necessary state information is available at the called object.

void IInternalMachineControl::pullGuestProperties ( out wstring[]  names,
out wstring[]  values,
out long long[]  timestamps,
out wstring[]  flags 
)

Get the list of the guest properties matching a set of patterns along with their values, time stamps and flags and give responsibility for managing properties to the console.

Parameters
namesThe names of the properties returned.
valuesThe values of the properties returned. The array entries match the corresponding entries in the name array.
timestampsThe time stamps of the properties returned. The array entries match the corresponding entries in the name array.
flagsThe flags of the properties returned. The array entries match the corresponding entries in the name array.
void IInternalMachineControl::pushGuestProperty ( in wstring  name,
in wstring  value,
in long long  timestamp,
in wstring  flags 
)

Update a single guest property in IMachine.

Parameters
nameThe name of the property to be updated.
valueThe value of the property.
timestampThe timestamp of the property.
flagsThe flags of the property.
void IInternalMachineControl::lockMedia ( )

Locks all media attached to the machine for writing and parents of attached differencing media (if any) for reading.

This operation is atomic so that if it fails no media is actually locked.

This method is intended to be called when the machine is in Starting or Restoring state. The locked media will be automatically unlocked when the machine is powered off or crashed.

void IInternalMachineControl::unlockMedia ( )

Unlocks all media previously locked using IInternalMachineControl::lockMedia.

This method is intended to be used with teleportation so that it is possible to teleport between processes on the same machine.

void IInternalMachineControl::ejectMedium ( in IMediumAttachment  attachment,
[retval] out IMediumAttachment  newAttachment 
)

Tells VBoxSVC that the guest has ejected the medium associated with the medium attachment.

Parameters
attachmentThe medium attachment where the eject happened.
newAttachmentA new reference to the medium attachment, as the config change can result in the creation of a new instance.
void IInternalMachineControl::reportVmStatistics ( in unsigned long  validStats,
in unsigned long  cpuUser,
in unsigned long  cpuKernel,
in unsigned long  cpuIdle,
in unsigned long  memTotal,
in unsigned long  memFree,
in unsigned long  memBalloon,
in unsigned long  memShared,
in unsigned long  memCache,
in unsigned long  pagedTotal,
in unsigned long  memAllocTotal,
in unsigned long  memFreeTotal,
in unsigned long  memBalloonTotal,
in unsigned long  memSharedTotal,
in unsigned long  vmNetRx,
in unsigned long  vmNetTx 
)

Passes statistics collected by VM (including guest statistics) to VBoxSVC.

Parameters
validStatsMask defining which parameters are valid. For example: 0x11 means that cpuIdle and XXX are valid. Other parameters should be ignored.
cpuUserPercentage of processor time spent in user mode as seen by the guest.
cpuKernelPercentage of processor time spent in kernel mode as seen by the guest.
cpuIdlePercentage of processor time spent idling as seen by the guest.
memTotalTotal amount of physical guest RAM.
memFreeFree amount of physical guest RAM.
memBalloonAmount of ballooned physical guest RAM.
memSharedAmount of shared physical guest RAM.
memCacheTotal amount of guest (disk) cache memory.
pagedTotalTotal amount of space in the page file.
memAllocTotalTotal amount of memory allocated by the hypervisor.
memFreeTotalTotal amount of free memory available in the hypervisor.
memBalloonTotalTotal amount of memory ballooned by the hypervisor.
memSharedTotalTotal amount of shared memory in the hypervisor.
vmNetRxNetwork receive rate for VM.
vmNetTxNetwork transmit rate for VM.