LocalPort Property

The TCP port in the local host where IPPort binds.

Syntax

sshtunnelcontrol.LocalPort[=long]

Default Value

0

Remarks

This property must be set before the control can start listening. If its value is 0, then the TCP/IP subsystem picks a port number at random. The port number can be found by checking the value of this property after the control is listening (ie. after successfully assigning True to the Listening property).

The service port is not shared among servers so two controls cannot be listening on the same port at the same time.

This property must be set before a connection is attempted. It instructs the control to bind to a specific port (or communication endpoint) in the local machine.

Setting this property to 0 (default) enables the system to choose a port at random. The chosen port will be shown by the LocalPort property after the connection is established.

LocalPort cannot be changed once a connection is made. Any attempt to set this property when a connection is active will generate an error.

This property is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems.

Data Type

Long