functions/runspace/Register-PSFRunspace.ps1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
function Register-PSFRunspace
{
<#
 .SYNOPSIS
  Registers a scriptblock to run in the background.
  
 .DESCRIPTION
  This function registers a scriptblock to run in separate runspace.
  This is different from most runspace solutions, in that it is designed for permanent background tasks that need to be done.
  It guarantees a single copy of the task to run within the powershell process, even when running the same module in many runspaces in parallel.
   
  The scriptblock must be built with some rules in mind, for details on using this system run:
  Get-Help about_psf_runspace
  
  Updating:
  If this function is called multiple times, targeting the same name, it will update the scriptblock.
  - If that scriptblock is the same as the previous scriptblock, nothing changes
  - If that scriptblock is different from the previous ones, it will be registered, but will not be executed right away!
    Only after stopping and starting the runspace will it operate under the new scriptblock.
  
 .PARAMETER ScriptBlock
  The scriptblock to run in a dedicated runspace
  
 .PARAMETER Name
  The name to register the scriptblock under.
  
 .EXAMPLE
  PS C:\> Register-PSFRunspace -ScriptBlock $scriptBlock -Name 'mymodule.maintenance'
  
  Registers the script defined in $scriptBlock under the name 'mymodule.maintenance'
  It does not start the runspace yet. If it already exists, it will overwrite the scriptblock without affecting the running script.
  
 .EXAMPLE
  PS C:\> Register-PSFRunspace -ScriptBlock $scriptBlock -Name 'mymodule.maintenance'
  PS C:\> Start-PSFRunspace -Name 'mymodule.maintenance'
  
  Registers the script defined in $scriptBlock under the name 'mymodule.maintenance'
  Then it starts the runspace, running the registered $scriptBlock
#>

    [CmdletBinding(PositionalBinding = $false)]
    param
    (
        [Parameter(Mandatory = $true)]
        [Scriptblock]
        $ScriptBlock,
        
        [Parameter(Mandatory = $true)]
        [String]
        $Name
    )
    
    if ([PSFramework.Runspace.RunspaceHost]::Runspaces.ContainsKey($Name.ToLower()))
    {
        Write-PSFMessage -Level Verbose -Message "Updating runspace: <c='Green'>$($Name.ToLower())</c>" -Target $Name.ToLower()
        [PSFramework.Runspace.RunspaceHost]::Runspaces[$Name.ToLower()].SetScript($ScriptBlock)
    }
    else
    {
        Write-PSFMessage -Level Verbose -Message "Registering runspace: <c='Green'>$($Name.ToLower())</c>" -Target $Name.ToLower()
        [PSFramework.Runspace.RunspaceHost]::Runspaces[$Name.ToLower()] = New-Object PSFramework.Runspace.RunspaceContainer($Name.ToLower(), $ScriptBlock)
    }
}