Merge pull request #52 from r3st0r3/master

Optimized Wait-PveTaskIsFinished

Author: franklupo

Corsinvest.ProxmoxVE.Api/Corsinvest.ProxmoxVE.Api.psm1

@@ -459,7 +459,7 @@ Millisecond wait next check
 .PARAMETER Timeout
 Millisecond timeout
 .OUTPUTS
-Bool. Return tas is running.
+Bool. $True Return task is done within Timeout, $False if not
 #>
     [OutputType([bool])]
     [CmdletBinding()]
@@ -479,21 +479,88 @@ Bool. Return tas is running.
 
     process {
         $isRunning = $true;
-        if ($wait -le 0) { $wait = 500; }
-        if ($timeOut -lt $wait) { $timeOut = $wait + 5000; }
+        if ($Wait -le 0) { $Wait = 500; }
+        if ($Timeout -lt $Wait) { $Timeout = $Wait + 5000; }
         $timeStart = [DateTime]::Now
-        $waitTime = $timeStart
 
-        while ($isRunning -and ($timeStart - [DateTime]::Now).Milliseconds -lt $timeOut) {
-            $now = [DateTime]::Now
-            if (($now - $waitTime).TotalMilliseconds -ge $wait) {
-                $waitTime = $now;
-                $isRunning = Get-PveTaskIsRunning -PveTicket $PveTicket -Upid $Upid
-            }
+        while ($isRunning -and ([DateTime]::Now - $timeStart).TotalMilliseconds -lt $Timeout) {
+            $isRunning = Get-PveTaskIsRunning -PveTicket $PveTicket -Upid $Upid
+            Start-Sleep -Milliseconds $Wait
+        }
+
+        #check timeout
+        return ([DateTime]::Now - $timeStart).TotalMilliseconds -lt $Timeout
+    }
+}
+
+function Wait-PveTaskIsFinishedWithProgress {
+    <#
+.DESCRIPTION
+Wait for a task to finish, show Powershell Progressbar while waiting
+.PARAMETER PveTicket
+Ticket data connection.
+.PARAMETER Upid
+Upid task e.g UPID:pve1:00004A1A:0964214C:5EECEF11:vzdump:134:root@pam:
+.PARAMETER Wait
+Millisecond wait next check
+.PARAMETER Timeout
+Millisecond timeout
+.PARAMETER ProgressActivityText
+Acitivity (Text) for Write-Progress, defaults to Upid when empty
+.PARAMETER ProgressStatusText
+Status-Text for Write-Progress, default is "Waiting...", is shown in front of remaining time and percent
+.PARAMETER ProgessActivityId
+Id for Write-Progress, change when other Write-Progress is already shown
+.OUTPUTS
+Bool. $True Return task is done within Timeout, $False if not
+#>
+    [OutputType([bool])]
+    [CmdletBinding()]
+    Param(
+        [Parameter(ValueFromPipeline, ValueFromPipelineByPropertyName)]
+        [PveTicket]$PveTicket,
+
+        [Parameter(Mandatory, ValueFromPipeline, ValueFromPipelineByPropertyName)]
+        [string]$Upid,
+
+        [Parameter(ValueFromPipeline, ValueFromPipelineByPropertyName)]
+        [int]$Wait = 500,
+
+        [Parameter(ValueFromPipeline, ValueFromPipelineByPropertyName)]
+        [int]$Timeout = 10000,
+
+        [Parameter(ValueFromPipeline, ValueFromPipelineByPropertyName)]
+        [string]$ProgressActivityText,
+
+        [Parameter(ValueFromPipeline, ValueFromPipelineByPropertyName)]
+        [string]$ProgressStatusText = "Waiting...",
+
+        [Parameter(ValueFromPipeline, ValueFromPipelineByPropertyName)]
+        [int]$ProgessActivityId = 1
+    )
+
+    process {
+        $isRunning = $true;
+        if ($Wait -le 0) { $Wait = 500; }
+        if ($Timeout -lt $Wait) { $Timeout = $Wait + 5000; }
+        if ($null -eq $ProgressActivityText -OR $ProgressActivityText -eq "") { $ProgressActivityText = $Upid; }
+        $timeStart = [DateTime]::Now
+        $waitTimeMs = $timeStart
+        $timePercent = 0
+
+        while ($isRunning -and ([DateTime]::Now - $timeStart).TotalMilliseconds -lt $Timeout) {
+            $waitTimeMs = $([DateTime]::Now - $timeStart).TotalMilliseconds
+            $timePercent = $waitTimeMs * (100 / $Timeout)
+            Write-Progress -Id $ProgessActivityId -Activity $ProgressActivityText -Status "$($ProgressStatusText) ($([Math]::Round($waitTimeMs/1000))/$([Math]::Round($Timeout/1000)) Seconds)" -PercentComplete $timePercent
+            $isRunning = Get-PveTaskIsRunning -PveTicket $PveTicket -Upid $Upid
+            Start-Sleep -Milliseconds $Wait
         }
 
+        # end Write-Progress
+        Write-Progress -Id $ProgessActivityId -Activity $ProgressActivityText -Completed
+
         #check timeout
-        return ($timeStart - [DateTime]::Now).Milliseconds -lt $timeOut
+        return ([DateTime]::Now - $timeStart).TotalMilliseconds -lt $Timeout
     }
 }
 
@@ -32855,3 +32922,8 @@ PveResponse. Return response.
 }
 
 
+
+
+
+
+