LocalPort Property

The TCP port in the local host where the component binds.

Object Oriented Interface

public function getLocalPort();
public function setLocalPort($value);

Procedural Interface

ipworks_rshell_get($res, 15 );
ipworks_rshell_set($res, 15, $value );

Default Value

0

Remarks

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

Setting it to 0 (default) enables the class 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 the LocalPort property when a connection is active will generate an error.

Use this property with caution. If you supply a value, it must be an available port on the system, or an error will be returned. Furthermore, the class always attempts to bind to a secure (sub 1000) port when the value of LocalPort is the default (0). If you supply your own value, make sure the remote system is configured to allow that particular value.

This property is not available at design time.

Data Type

Long