Repository navigation
Expand file tree
/
Copy pathDisconnect-ModuleWebSocket.ps1
More file actions
78 lines (64 loc) · 3.41 KB
/
Copy pathDisconnect-ModuleWebSocket.ps1
File metadata and controls
78 lines (64 loc) · 3.41 KB
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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
<#
.SYNOPSIS
Close and dispose the active WebSocket connection.
.DESCRIPTION
`Disconnect-ModuleWebSocket` attempts a graceful close of the active
`ClientWebSocket` then disposes runtime resources. It returns structured
module results for success, not-connected, and various error conditions.
.OUTPUTS
System.Object -- Structured `Write-FunctionReturnValue` values describing the outcome.
.EXAMPLE
PS> Disconnect-ModuleWebSocket
.NOTES
This function is safe to call even when no connection exists. It ensures cleanup
of any lingering `ClientWebSocket` and `CancellationTokenSource` objects to
avoid memory leaks. The function accesses runtime state via
`Get-GlobalRuntimeVariable`.
SPDX-FileCopyrightText: 2026 Icinga GmbH <https://icinga.com>
SPDX-License-Identifier: GPL-3.0-or-later
#>
function Disconnect-ModuleWebSocket()
{
# First try to close the WebSocket connection gracefully
try {
$GlobalVariable = Get-GlobalRuntimeVariable;
if (Test-ModuleWebSocket) {
$CancelTokenSource = $GlobalVariable.Private.WebSocket.CancellationTokenSource;
$CancelTokenSource.Cancel();
$CloseProgress = $GlobalVariable.Private.WebSocket.ClientWebSocket.CloseAsync(
[System.Net.WebSockets.WebSocketCloseStatus]::NormalClosure,
'Closing WebSocket connection',
[System.Threading.CancellationToken]::None
);
# Wait until we closed the connection
While ($CloseProgress.IsCompleted -eq $FALSE) {
Start-Sleep -Milliseconds 10;
}
# Clear our close progress to avoid memory leaks
$CloseProgress.Dispose();
$CloseProgress = $null;
$GlobalVariable.Private.WebSocket.ClientWebSocket.Dispose();
$GlobalVariable.Private.WebSocket.ClientWebSocket = $null;
$GlobalVariable.Private.WebSocket.CancellationTokenSource.Dispose();
$GlobalVariable.Private.WebSocket.CancellationTokenSource = $null;
return (Write-FunctionReturnValue -ReturnValue 'WebSocketDisconnectedSuccessfully' -Data @{ 'Name' = $GlobalVariable.Private.WebSocket.Name; } );
}
return (Write-FunctionReturnValue -ReturnValue 'WebSocketNotConnected' -Data @{ 'Name' = $GlobalVariable.Private.WebSocket.Name; } );
} catch {
Write-FunctionReturnValue -ReturnValue 'WebSocketDisconnectError' -Data @{ 'Exception' = $_.Exception; 'Name' = $GlobalVariable.Private.WebSocket.Name; } | Out-Null;
}
# Ensure all resources are cleaned up
try {
if ($null -ne $GlobalVariable.Private.WebSocket.ClientWebSocket) {
$GlobalVariable.Private.WebSocket.ClientWebSocket.Dispose();
$GlobalVariable.Private.WebSocket.ClientWebSocket = $null;
}
if ($null -ne $GlobalVariable.Private.WebSocket.CancellationTokenSource) {
$GlobalVariable.Private.WebSocket.CancellationTokenSource.Dispose();
$GlobalVariable.Private.WebSocket.CancellationTokenSource = $null;
}
return (Write-FunctionReturnValue -ReturnValue 'WebSocketDisposedSuccessfully' -Data @{ 'Exception' = $_.Exception; 'Name' = $GlobalVariable.Private.WebSocket.Name; });
} catch {
return (Write-FunctionReturnValue -ReturnValue 'WebSocketDisposeError' -Data @{ 'Exception' = $_.Exception; 'Name' = $GlobalVariable.Private.WebSocket.Name; });
}
}