Platforms to show: All Mac Windows Linux Cross-Platform

Back to SSH2TunnelMBS class.

SSH2TunnelMBS.BytesReceived as Int64

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Network MBS Network Plugin 18.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Number of bytes received.

(Read only property)

SSH2TunnelMBS.BytesSent as Int64

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Network MBS Network Plugin 18.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Number of bytes sent.

(Read only property)

SSH2TunnelMBS.Cancel as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Network MBS Network Plugin 18.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Whether to cancel tunnel.

This property can be set to request end of the thread.
(Read and Write property)

SSH2TunnelMBS.Connected as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Network MBS Network Plugin 20.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Queries whether tunnel is connected and transfers data.

Returns true if connected or false if not.
(Read only property)

SSH2TunnelMBS.KeepAlive as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Network MBS Network Plugin 20.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Whether to sent keep-alive packets.
Example
dim tunnel as SSH2TunnelMBS // your tunnel

// avoid timeing out in Socket and SSH layers
tunnel.KeepAlive = True
session.ConfigureKeepAlive

If set to true, TCP keep alive probes will be sent to avoid TCP/IP timeouts.
Set to false (default behavior) to disable keep alive probes.

You may also need to use ConfigureKeepAlive on the SSH2SessionMBS class.
(Read and Write property)

Some examples using this property:

SSH2TunnelMBS.LocalAddress as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Network MBS Network Plugin 18.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The local address to use.

Defines where we wait for a connection to forward.
IPv4 or IPv6 address.
(Read and Write property)

SSH2TunnelMBS.LocalPort as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Network MBS Network Plugin 18.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The local port to use.

(Read and Write property)

SSH2TunnelMBS.Messages as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Network MBS Network Plugin 18.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Log messages.

Filled by thread to tell you about errors.
(Read only property)

SSH2TunnelMBS.RemoteAddress as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Network MBS Network Plugin 18.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The remote address to use.

When connecting through tunnel this address is used from server to connect to.
IPv4 or IPv6 address.
(Read and Write property)

SSH2TunnelMBS.RemotePort as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Network MBS Network Plugin 18.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The remote port to use.

When connecting through tunnel this port is used from server to connect to.
(Read and Write property)

SSH2TunnelMBS.Running as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Network MBS Network Plugin 18.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Whether tunnel is running.

True if running, false if not.
(Read only property)

SSH2TunnelMBS.Session as SSH2SessionMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Network MBS Network Plugin 18.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The session used for the tunnel.

(Read only property)

The items on this page are in the following plugins: MBS Network Plugin.


The biggest plugin in space...