Protocol Property

Sets the protocol to use for the transfer.

Syntax

 rcp.getProtocol([callback])
 rcp.setProtocol( protocol, [callback])

Possible Values

  0 (protRexec), 
  1 (protRshell)

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 getProtocol([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 setProtocol([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

This property determines the protocol mechanism used to communicate with the remote host. It has two possible values:

protRexec (0)The class uses the REXEC protocol is used for data transfer.
protRshell (1)The class uses the RSHELL protocol is used for data transfer.

The default value is protRexec. (protRshell is not generally recommended because of potential security issues.)

Data Type

Integer

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