Command Property

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

Syntax


 telnet.setCommand( command, [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 getCommand([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 setCommand([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

Codes for Telnet commands and their meanings are defined in the Telnet RFCs. Here are some examples:

241 (NOP)No operation.
242 (Data Mark)The data stream portion of a Synch. This should always be accompanied by a TCP Urgent notification.
243 (Break)NVT character BRK.
244 (Interrupt Process)The function IP.
245 (Abort Output)The function AO.
246 (Are You There)The function AYT.
247 (Erase Character)The function EC.
248 (Erase Line)The function EL.
249 (Go Ahead)The GA signal.

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]