| /* |
| Copyright (c) 2015 VMware, Inc. All Rights Reserved. |
| |
| Licensed under the Apache License, Version 2.0 (the "License"); |
| you may not use this file except in compliance with the License. |
| You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, software |
| distributed under the License is distributed on an "AS IS" BASIS, |
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| See the License for the specific language governing permissions and |
| limitations under the License. |
| */ |
| |
| package object |
| |
| import ( |
| "context" |
| |
| "github.com/vmware/govmomi/property" |
| "github.com/vmware/govmomi/task" |
| "github.com/vmware/govmomi/vim25" |
| "github.com/vmware/govmomi/vim25/methods" |
| "github.com/vmware/govmomi/vim25/progress" |
| "github.com/vmware/govmomi/vim25/types" |
| ) |
| |
| // Task is a convenience wrapper around task.Task that keeps a reference to |
| // the client that was used to create it. This allows users to call the Wait() |
| // function with only a context parameter, instead of a context parameter, a |
| // soap.RoundTripper, and reference to the root property collector. |
| type Task struct { |
| Common |
| } |
| |
| func NewTask(c *vim25.Client, ref types.ManagedObjectReference) *Task { |
| t := Task{ |
| Common: NewCommon(c, ref), |
| } |
| |
| return &t |
| } |
| |
| func (t *Task) Wait(ctx context.Context) error { |
| _, err := t.WaitForResult(ctx, nil) |
| return err |
| } |
| |
| func (t *Task) WaitForResult(ctx context.Context, s progress.Sinker) (*types.TaskInfo, error) { |
| p := property.DefaultCollector(t.c) |
| return task.Wait(ctx, t.Reference(), p, s) |
| } |
| |
| func (t *Task) Cancel(ctx context.Context) error { |
| _, err := methods.CancelTask(ctx, t.Client(), &types.CancelTask{ |
| This: t.Reference(), |
| }) |
| |
| return err |
| } |