PipelineLength Property
The number of parallelized transfer requests.
Syntax
sftpclient.getPipelineLength([callback]) sftpclient.setPipelineLength( pipelineLength, [callback])
Default Value
32
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 getPipelineLength([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 setPipelineLength([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 controls the number of upload/download requests sent simultaneously. This speeds the transfer up, but may lead to issues with older/immature servers.
Typically you will only need to adjust this property if the default transfer settings (AutoAdjustTransferBlock) don't work.
Data Type
Integer