IP*Works! V9 - Online Help
IP*Works! V9
Questions / Feedback?

LocalPort Property

The TCP port in the local host where IPPort binds.

Syntax

 telnet.getLocalPort([callback])
 telnet.setLocalPort( localPort, [callback])

Default Value

0


Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getLocalPort([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setLocalPort([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

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 TCP/IP stack 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.

The LocalPort property is useful when trying to connect to services that require a trusted port in the client side.

Data Type

Long

 
 
Copyright (c) 2018 /n software inc. - All rights reserved.
Build 9.0.6635.0