WontOption Property

A single character Telnet option code to be sent to the server with the Telnet WONT command.

Syntax


 telnet.setWontOption( wontOption, [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 getWontOption([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 setWontOption([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

For a list of option codes and their descriptions, please look at the Telnet RFCs. The following are a few examples:

0 (TRANSMIT-BINARY)Enables or disables binary (8 bit) transmission.
1 (ECHO)Telnet ECHO option. Specifies whether bytes sent should be echoed or not.
3 (SUPPRESS-GO-AHEAD)Used to enable or disable transmission of the Telnet GO_AHEAD command.
24 (TERMINAL-TYPE)Allows or disallows terminal type negotiation.
31 (NAWS)Allows or disallows window size negotiation.

This property is write-only and not available at design time.

Data Type

Integer

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks 2020 Node.js Edition - Version 20.0 [Build 8307]