Posh-SYSLOG

4.1.5

private/Disconnect-UDPClient.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
 Function Disconnect-UDPClient
{
    <#
        .SYNOPSIS
        Disconnects/Closes a UdpClient Object
 
        .DESCRIPTION
        Internal function.
 
        Disconnects/closes an open UdpClient.
 
        .EXAMPLE
        Disconnect-UdpClient -UdpClient $Client
        Closes the client $client.
 
        .OUTPUTS
        None
    #>

    [CmdletBinding()]
    param
    (
        # UdpClient that is connected to an endpoint
        [Parameter(Mandatory   = $true,
                   HelpMessage = 'UdpClient that is connected to an endpoint')]
        [ValidateNotNullOrEmpty()]
        [Net.Sockets.UdpClient]
        $UdpClient
    )

    Try
    {
        $UdpClient.Close()
        Write-Debug -message ('Connection Closed')
    }
    Catch
    {
        Throw $_
    }

}