Skip to content

Commit 501da2e

Browse files
FriedrichWeinmannFriedrichWeinmann
authored
Merge pull request #709 from PowershellFrameworkCollective/runspaces
1.13.425
2 parents c13069d + 85e6370 commit 501da2e

25 files changed

+639
-123
lines changed

‎.github/workflows/validate.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ jobs:
1010
- name: Install Prerequisites
1111
run: .\build\psf-prerequisites.ps1
1212
shell: powershell
13-
- name: Install Prerequisites
13+
- name: Compile Help
1414
run: .\build\vsts-help.ps1
1515
shell: powershell
1616
- name: Validate

‎PSFramework/PSFramework.psd1‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
RootModule = 'PSFramework.psm1'
55

66
# Version number of this module.
7-
ModuleVersion = '1.13.419'
7+
ModuleVersion = '1.13.425'
88

99
# ID used to uniquely identify this module
1010
GUID = '8028b914-132b-431f-baa9-94a6952f21ff'

‎PSFramework/bin/PSFramework.dll‎

2 KB
Binary file not shown.

‎PSFramework/bin/PSFramework.pdb‎

6 KB
Binary file not shown.

‎PSFramework/bin/PSFramework.xml‎

Lines changed: 137 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4590,6 +4590,11 @@
45904590
Whether the console messages should be written with only one color, rather than respecting color tags
45914591
</summary>
45924592
</member>
4593+
<member name="F:PSFramework.Message.MessageHost.OldColor">
4594+
<summary>
4595+
Whether the console messages should be written with multiple Write-Hosts, rather than one using ANSI sequences
4596+
</summary>
4597+
</member>
45934598
<member name="F:PSFramework.Message.MessageHost.TimeFormat">
45944599
<summary>
45954600
The format used in messages written on screen
@@ -8478,6 +8483,11 @@
84788483
Class that contains the logic necessary to manage a unique runspace
84798484
</summary>
84808485
</member>
8486+
<member name="P:PSFramework.Runspace.RunspaceContainer.Generation">
8487+
<summary>
8488+
The Generation of the Managed Runspace, determining the featureset used by it.
8489+
</summary>
8490+
</member>
84818491
<member name="F:PSFramework.Runspace.RunspaceContainer.Name">
84828492
<summary>
84838493
The name of the runspace.
@@ -8488,17 +8498,64 @@
84888498
The Guid of the running Runspace
84898499
</summary>
84908500
</member>
8501+
<member name="P:PSFramework.Runspace.RunspaceContainer.Script">
8502+
<summary>
8503+
The Code that will be used when running the runspace.
8504+
</summary>
8505+
</member>
84918506
<member name="M:PSFramework.Runspace.RunspaceContainer.SetScript(System.Management.Automation.ScriptBlock)">
84928507
<summary>
84938508
Sets the script to execute in the runspace. Will NOT take immediate effect. Only after restarting the runspace will it be used.
84948509
</summary>
84958510
<param name="Script">The scriptblock to execute</param>
84968511
</member>
8512+
<member name="M:PSFramework.Runspace.RunspaceContainer.#ctor(System.String,System.Management.Automation.ScriptBlock)">
8513+
<summary>
8514+
Creates a new Gen 1 runspace container with the basic information needed
8515+
</summary>
8516+
<param name="Name">The name of the Runspace</param>
8517+
<param name="Script">The code using the runspace logic</param>
8518+
</member>
8519+
<member name="P:PSFramework.Runspace.RunspaceContainer.Begin">
8520+
<summary>
8521+
The initialization code of the runspace, executed in the global scope.
8522+
</summary>
8523+
</member>
8524+
<member name="P:PSFramework.Runspace.RunspaceContainer.Process">
8525+
<summary>
8526+
The execution code of the runspace, will be called repeatedly over the time of the runspace.
8527+
</summary>
8528+
</member>
8529+
<member name="P:PSFramework.Runspace.RunspaceContainer.End">
8530+
<summary>
8531+
The finalization code of the runspace, will be called once when closing out the runspace.
8532+
</summary>
8533+
</member>
8534+
<member name="M:PSFramework.Runspace.RunspaceContainer.#ctor(System.String,System.Management.Automation.ScriptBlock,System.Management.Automation.ScriptBlock,System.Management.Automation.ScriptBlock)">
8535+
<summary>
8536+
Creates a new Gen 2 runspace container with the basic information needed
8537+
</summary>
8538+
<param name="Name">The name of the Runspace</param>
8539+
<param name="Begin">The initialization code of the runspace, executed in the global scope.</param>
8540+
<param name="Process">The execution code of the runspace, will be called repeatedly over the time of the runspace.</param>
8541+
<param name="End">The finalization code of the runspace, will be called once when closing out the runspace.</param>
8542+
</member>
8543+
<member name="M:PSFramework.Runspace.RunspaceContainer.GetRuntime">
8544+
<summary>
8545+
Initialize a runtime reference for the current managed runspace
8546+
</summary>
8547+
<returns>A Runtime reference, including the code for all three phases of a Gen 2 Managed Runspace</returns>
8548+
</member>
84978549
<member name="P:PSFramework.Runspace.RunspaceContainer.State">
84988550
<summary>
84998551
The state the runspace currently is in.
85008552
</summary>
85018553
</member>
8554+
<member name="F:PSFramework.Runspace.RunspaceContainer.Errors">
8555+
<summary>
8556+
The last 50 errors that happened in the runspace
8557+
</summary>
8558+
</member>
85028559
<member name="M:PSFramework.Runspace.RunspaceContainer.Start">
85038560
<summary>
85048561
Starts the Runspace.
@@ -8525,33 +8582,54 @@
85258582
Signals the registered runspace has stopped execution
85268583
</summary>
85278584
</member>
8528-
<member name="M:PSFramework.Runspace.RunspaceContainer.#ctor(System.String,System.Management.Automation.ScriptBlock)">
8585+
<member name="M:PSFramework.Runspace.RunspaceContainer.SignalFailed">
85298586
<summary>
8530-
Creates a new runspace container with the basic information needed
8587+
Signals the registered runspace has failed badly and error logs should be checked.
85318588
</summary>
8532-
<param name="Name">The name of the Runspace</param>
8533-
<param name="Script">The code using the runspace logic</param>
85348589
</member>
85358590
<member name="T:PSFramework.Runspace.RunspaceHost">
85368591
<summary>
85378592
Provides hosting for all registered runspaces
85388593
</summary>
85398594
</member>
8540-
<member name="F:PSFramework.Runspace.RunspaceHost.StopTimeoutSeconds">
8595+
<member name="P:PSFramework.Runspace.RunspaceHost.RbvCleanupInterval">
85418596
<summary>
8542-
The number of seconds before a Stop command is interrupted and instead the runspace is gracelessly shut down.
8597+
The interval (in milliseonds) in which Runspace-Bound Values will be leaned up
85438598
</summary>
85448599
</member>
8545-
<member name="P:PSFramework.Runspace.RunspaceHost.RbvCleanupInterval">
8600+
<member name="F:PSFramework.Runspace.RunspaceHost.StopTimeoutSeconds">
85468601
<summary>
8547-
The interval (in milliseonds) in which Runspace-Bound Values will be leaned up
8602+
The number of seconds before a Stop command is interrupted and instead the runspace is gracelessly shut down.
85488603
</summary>
85498604
</member>
85508605
<member name="F:PSFramework.Runspace.RunspaceHost.Runspaces">
85518606
<summary>
85528607
The dictionary containing the definitive list of unique Runspace
85538608
</summary>
85548609
</member>
8610+
<member name="M:PSFramework.Runspace.RunspaceHost.SetManagedRunspace(System.String,System.Management.Automation.ScriptBlock)">
8611+
<summary>
8612+
Define the managed runspace or update its code as a Gen 1 Runspace
8613+
</summary>
8614+
<param name="Name">The name of the managed runspace</param>
8615+
<param name="Code">The code implementing the managed runspace</param>
8616+
<returns>Whether the runspace was created new (true) or merely updated (false)</returns>
8617+
</member>
8618+
<member name="M:PSFramework.Runspace.RunspaceHost.SetManagedRunspace(System.String,System.Management.Automation.ScriptBlock,System.Management.Automation.ScriptBlock,System.Management.Automation.ScriptBlock)">
8619+
<summary>
8620+
Define the managed runspace or update its code as a Gen 2 Runspace
8621+
</summary>
8622+
<param name="Name">The name of the managed runspace</param>
8623+
<param name="Begin">The Begin stage of the managed runspace</param>
8624+
<param name="Process">The Process stage of the managed runspace</param>
8625+
<param name="End">The End stage of the managed runspace</param>
8626+
<returns>Whether the runspace was created new (true) or merely updated (false)</returns>
8627+
</member>
8628+
<member name="P:PSFramework.Runspace.RunspaceHost.ManagedRunspaceCodeGen2">
8629+
<summary>
8630+
The Code to use for Gen 2 Managed Runspaces
8631+
</summary>
8632+
</member>
85558633
<member name="P:PSFramework.Runspace.RunspaceHost._RunspaceBoundValues">
85568634
<summary>
85578635
List of all runspace bound values in use
@@ -8708,6 +8786,47 @@
87088786
<param name="Output">The output result of the task</param>
87098787
<param name="Streams">The streams the task sent</param>
87108788
</member>
8789+
<member name="T:PSFramework.Runspace.RunspaceRuntime">
8790+
<summary>
8791+
Wrapper around the execution stages of a Generation 2 Managed Runspace
8792+
</summary>
8793+
</member>
8794+
<member name="F:PSFramework.Runspace.RunspaceRuntime.Begin">
8795+
<summary>
8796+
Begin phase of the Managed Runspace
8797+
</summary>
8798+
</member>
8799+
<member name="F:PSFramework.Runspace.RunspaceRuntime.Process">
8800+
<summary>
8801+
Process phase of the Managed Runspace
8802+
</summary>
8803+
</member>
8804+
<member name="F:PSFramework.Runspace.RunspaceRuntime.End">
8805+
<summary>
8806+
End phase of the Managed Runspace
8807+
</summary>
8808+
</member>
8809+
<member name="F:PSFramework.Runspace.RunspaceRuntime.Errors">
8810+
<summary>
8811+
Access to the error queue of the managed runspace
8812+
</summary>
8813+
</member>
8814+
<member name="F:PSFramework.Runspace.RunspaceRuntime.Workload">
8815+
<summary>
8816+
The actual runspace container with the original task.
8817+
MAY BE MODIFIED after launch, should not be used for critical lifestate data.
8818+
</summary>
8819+
</member>
8820+
<member name="M:PSFramework.Runspace.RunspaceRuntime.#ctor(System.Management.Automation.ScriptBlock,System.Management.Automation.ScriptBlock,System.Management.Automation.ScriptBlock,PSFramework.Utility.LimitedConcurrentQueue{System.Management.Automation.ErrorRecord},PSFramework.Runspace.RunspaceContainer)">
8821+
<summary>
8822+
Create a new Managed Runspace Runtime wrapper
8823+
</summary>
8824+
<param name="Begin">Begin phase of the Managed Runspace</param>
8825+
<param name="Process">Process phase of the Managed Runspace</param>
8826+
<param name="End">End phase of the Managed Runspace</param>
8827+
<param name="Errors">Access to the error queue of the managed runspace</param>
8828+
<param name="Workload">The actual runspace container with the original task.</param>
8829+
</member>
87118830
<member name="T:PSFramework.Runspace.PsfRunspaceState">
87128831
<summary>
87138832
Contains the state a managed, unique runspace can be in.
@@ -8728,6 +8847,11 @@
87288847
The runspace has followed its order to stop and is currently disabled
87298848
</summary>
87308849
</member>
8850+
<member name="F:PSFramework.Runspace.PsfRunspaceState.Failed">
8851+
<summary>
8852+
The runspace crashed and burned. It is also stopped without fracefully closing out, check the Errors property.
8853+
</summary>
8854+
</member>
87318855
<member name="T:PSFramework.Runspace.RunspaceTask">
87328856
<summary>
87338857
An individual task executed in the runspace pool of its hosting RunspaceWrapper
@@ -9638,6 +9762,11 @@
96389762
The task code to execute
96399763
</summary>
96409764
</member>
9765+
<member name="F:PSFramework.TaskEngine.PsfTask.ArgumentList">
9766+
<summary>
9767+
Arguments to provide to the task code
9768+
</summary>
9769+
</member>
96419770
<member name="P:PSFramework.TaskEngine.PsfTask.IsDue">
96429771
<summary>
96439772
Whether the task is due and should be executed

‎PSFramework/changelog.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
# CHANGELOG
22

3+
## 1.13.425 (2026-01-07)
4+
5+
- New: Configuration `PSFramework.Message.Style.OldColor` - reverts update to message printing, disabling use of ANSI codes for colors
6+
- Upd: Register-PSFRunspace - Significantly reworked Managed Runspaces for greater ease of use.
7+
- Upd: Register-PSFTaskEngineTask - Added `-ArgumentList` parameter to enable including data with Task
8+
- Fix: Write-PSFMessage - Messages to host get jumbled when logging from parallel tasks (#707)
9+
- Fix: Register-PSFRunspace - Closed Constrained Language Mode escape
10+
- Fix: Register-PSFRunspace - Closed edge-case concurrency issue that was extremely unlikely to ever matter.
11+
312
## 1.13.419 (2025-11-24)
413

514
- Fix: Get-PSFRunspaceLock - Fails to create new runspace lock.

‎PSFramework/en-us/about_psf_runspace.help.txt‎

Lines changed: 0 additions & 20 deletions
This file was deleted.

0 commit comments

Comments
 (0)