Xceed .NET Libraries Documentation
Xceed.SSH.Core Assembly / Xceed.SSH.Core Namespace / ProxyClient Class / Handshake Method
A System.IO.Stream that represents the network stream to the proxy server.
A System.String that represents the address of the SSH server to connect to.
A System.Byte that represents the port number of the SSH server.


In This Topic
    Handshake Method (ProxyClient)
    In This Topic
    Instruct the proxy server to connect itself to the SSH server on our behalf.
    Syntax
    'Declaration
     
    Public MustOverride Function Handshake( _
       ByVal socketStream As Stream, _
       ByVal hostName As String, _
       ByVal port As Integer _
    ) As Byte()
    'Usage
     
    Dim instance As ProxyClient
    Dim socketStream As Stream
    Dim hostName As String
    Dim port As Integer
    Dim value() As Byte
     
    value = instance.Handshake(socketStream, hostName, port)
    public abstract byte[] Handshake( 
       Stream socketStream,
       string hostName,
       int port
    )

    Parameters

    socketStream
    A System.IO.Stream that represents the network stream to the proxy server.
    hostName
    A System.String that represents the address of the SSH server to connect to.
    port
    A System.Byte that represents the port number of the SSH server.

    Return Value

    A System.Byte array that contains any data that might have been received immediately after the handshake completed. Can be a null reference (Nothing in Visual Basic).
    Exceptions
    ExceptionDescription
    If an error occurred while communicating with the proxy server. Examine the System.Exception.InnerException property for the actual exception.
    Requirements

    Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

    See Also