Add comments

Signed-off-by: David Gageot <david@gageot.net>
This commit is contained in:
David Gageot 2015-12-23 09:30:45 +01:00
parent 7e7c83427a
commit a4995adbc7
1 changed files with 6 additions and 0 deletions

View File

@ -33,6 +33,7 @@ const (
defaultCPU = 1 defaultCPU = 1
) )
// NewDriver creates a new Hyper-v driver with default settings.
func NewDriver(hostName, storePath string) *Driver { func NewDriver(hostName, storePath string) *Driver {
return &Driver{ return &Driver{
DiskSize: defaultDiskSize, DiskSize: defaultDiskSize,
@ -258,6 +259,7 @@ func (d *Driver) wait() error {
return nil return nil
} }
// Start starts an host
func (d *Driver) Start() error { func (d *Driver) Start() error {
if err := cmd("Start-VM", "-Name", d.MachineName); err != nil { if err := cmd("Start-VM", "-Name", d.MachineName); err != nil {
return err return err
@ -273,6 +275,7 @@ func (d *Driver) Start() error {
return err return err
} }
// Stop stops an host
func (d *Driver) Stop() error { func (d *Driver) Stop() error {
if err := cmd("Stop-VM", "-Name", d.MachineName); err != nil { if err := cmd("Stop-VM", "-Name", d.MachineName); err != nil {
return err return err
@ -296,6 +299,7 @@ func (d *Driver) Stop() error {
return nil return nil
} }
// Remove removes an host
func (d *Driver) Remove() error { func (d *Driver) Remove() error {
s, err := d.GetState() s, err := d.GetState()
if err != nil { if err != nil {
@ -311,6 +315,7 @@ func (d *Driver) Remove() error {
return cmd("Remove-VM", "-Name", d.MachineName, "-Force") return cmd("Remove-VM", "-Name", d.MachineName, "-Force")
} }
// Restart stops and starts an host
func (d *Driver) Restart() error { func (d *Driver) Restart() error {
err := d.Stop() err := d.Stop()
if err != nil { if err != nil {
@ -320,6 +325,7 @@ func (d *Driver) Restart() error {
return d.Start() return d.Start()
} }
// Kill force stops an host
func (d *Driver) Kill() error { func (d *Driver) Kill() error {
if err := cmd("Stop-VM", "-Name", d.MachineName, "-TurnOff"); err != nil { if err := cmd("Stop-VM", "-Name", d.MachineName, "-TurnOff"); err != nil {
return err return err