AutoAdjustTransferBlock Property
Specifies whether to adjust the send and receive buffer sizes automatically.
Syntax
sftpclient.getAutoAdjustTransferBlock([callback]) sftpclient.setAutoAdjustTransferBlock( autoAdjustTransferBlock, [callback])
Default Value
TRUE
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 getAutoAdjustTransferBlock([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 setAutoAdjustTransferBlock([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
Automatic transfer block size adjustment may be beneficial for maximizing interoperability and achieving the best transfer speeds.
Use DownloadBlockSize, UploadBlockSize, and PipelineLength properties to adjust the transfer settings manually.
Data Type
Boolean