SSH.TCPTunnel

SSH.TCPTunnel

Class Declaration

 Protected Class TCPTunnel
 Inherits SSH.Channel

Remarks

This class represents a TCP connection that is being forwarded over the SSH session. To initiate an outbound connection from the client to a third party, using the SSH server as an intermediary, call the Connect() method. To accept inbound connections from a third-party refer to the TCPListener class.

Example

This example forwards an HTTP request through the SSH server to www.google.com:80.

  Dim session As SSH.Session = SSH.Connect("ssh.example.com", 22, "username", "password")
  Dim tunnel As New SSH.TCPTunnel(Session)
  tunnel.RemoteAddress = "www.google.com"
  tunnel.RemotePort = 80
  If Not tunnel.Connect() Then MsgBox("Unable to open tunnel.")

  ' write to the tunnel
  tunnel.Write( _
     "GET / HTTP/1.0" + EndOfLine.Windows + _
     "Host: www.google.com" + EndOfLine.Windows + _
     "Connection: close" + EndOfLine.Windows + EndOfLine.Windows)
  
  ' read from the tunnel
  Dim output As String
  Do Until tunnel.EOF
    If tunnel.PollReadable() Then
      output = output + tunnel.Read(tunnel.BytesReadable)
    End If
  Loop

Event definitions

• Connected
• DataAvailable
• Disconnected
• Error

Methods

• Close
• Connect
• EOF
• Flush
• Poll
• PollReadable
• PollWriteable
• Read
• ReadError
• WaitClose
• WaitEOF
• Write
• WriteError

Properties

• BytesReadable As UInt32
• BytesWriteable As UInt32
• Handle As Ptr
• IsOpen As Boolean
• LastError As Int32
• LocalInterface As NetworkInterface
• LocalPort As Integer
• ReadWindow As UInt32
• RemoteAddress As String
• RemoteBytesWriteable As UInt32
• RemotePort As Integer
• Session As SSH.Session
• WriteWindow As UInt32

See also

• Channel class
• TCPListener class