Posh-SYSLOG

3.1.1

Functions/Disconnect-TCPClient.ps1

Function Disconnect-TCPClient
{
    <#
            .SYNOPSIS
            Disconnects/Closes a TCPClient Object
 
            .DESCRIPTION
            Internal function.
         
            Disconnects/closes an open TCPClient.
 
            .EXAMPLE
            Disconnect-TCPClient -TcpClient $Client
            Closes the client $client.
 
            .OUTPUTS
            None
    #>
    
    [CmdletBinding()]
    [OutputType($null)]
    param
    (
        # TCP Client that is connected to an endpoint
        [Parameter(Mandatory   = $true,
                   HelpMessage = 'TCP Client that is connected to an endpoint')]
        [ValidateNotNullOrEmpty()]
        [Net.Sockets.TcpClient]
        $TcpClient
    )

    Try 
    {
        $TcpClient.Close()
    }
    Catch 
    {
        Throw $_
    }
}