Cosmos/source/Archive/VMWareLib/VMWareJobCallback.cs

using System;
using System.Collections.Generic;
using System.Text;
using System.Threading;
using Interop.VixCOM;

namespace Vestris.VMWareLib
{
    /// <summary>
    /// A job completion callback, used with <see cref="Vestris.VMWareLib.VMWareJob" />.
    /// </summary>
    public class VMWareJobCallback : ICallback
    {
        #region ICallback Members

        private EventWaitHandle _jobCompleted = new EventWaitHandle(false, EventResetMode.ManualReset);

        /// <summary>
        /// Handle a Vix event.
        /// </summary>
        /// <param name="job">An instance that implements IJob.</param>
        /// <param name="eventType">Event type.</param>
        /// <param name="moreEventInfo">Additional event info.</param>
        public void OnVixEvent(IJob job, int eventType, IVixHandle moreEventInfo)
        {
            using(VMWareVixHandle<IJob> jobHandle = new VMWareVixHandle<IJob>(job))
            {
                using (VMWareVixHandle<IVixHandle> moreEventInfoHandle = new VMWareVixHandle<IVixHandle>(moreEventInfo))
                {
                    OnVixEvent(jobHandle, eventType, moreEventInfo);
                }
            }
        }

        /// <summary>
        /// Handle a Vix event.
        /// Currently handles the job completion event, call WaitForCompletion to block with a timeout.
        /// </summary>
        /// <param name="job">An instance that implements IJob.</param>
        /// <param name="eventType">Event type.</param>
        /// <param name="moreEventInfo">Additional event info.</param>
        private void OnVixEvent(VMWareVixHandle<IJob> job, int eventType, IVixHandle moreEventInfo)
        {
            switch (eventType)
            {
                case Constants.VIX_EVENTTYPE_JOB_COMPLETED:
                    _jobCompleted.Set();
                    break;
            }
        }

        /// <summary>
        /// Wait for completion of the job with a timeout.
        /// </summary>
        /// <param name="timeoutInMilliseconds">Timeout in milliseconds.</param>
        /// <returns>True if job completed, false if timeout expired.</returns>
        public bool TryWaitForCompletion(int timeoutInMilliseconds)
        {
            return _jobCompleted.WaitOne(timeoutInMilliseconds, false);
        }

        /// <summary>
        /// Wait for completion of the job with a timeout.
        /// A <see cref="System.TimeoutException" /> occurs if the job hasn't completed within the timeout specified.
        /// </summary>
        /// <param name="timeoutInMilliseconds">Timeout in milliseconds.</param>
        public void WaitForCompletion(int timeoutInMilliseconds)
        {
            if (!TryWaitForCompletion(timeoutInMilliseconds))
            {
                throw new TimeoutException(string.Format("The operation has timed out after {0} milliseconds.", timeoutInMilliseconds));
            }
        }

        #endregion
    }
}