ssCore.FTP.bufferSize

Allows you to set the size of the internal transfer buffer used to send and receive data in an FTP session.


Availability:

First available in version 3.0 build 2039.


Input Parameters:

size - [Optional] - The number of bytes to be used for a transfer buffer. If you don't set the buffer size, the plugin will use a default value of "8192" (8K). Default value is 8192.


Output Parameters:

No output parameters.


Asynchronous Mode:

When this method is called asynchronously, a return object containing the output parameters is passed to the specified callback function.

ssCore.FTP.bufferSize( paramsObject [, callbackParamsObject] [, errorParamsObject] );


Synchronous Mode:

When this method is called synchronously, a return object containing the output parameters is returned to the caller immediately.

var returnObject = ssCore.FTP.bufferSize( paramsObject );


Notes:

Smaller buffers increase the number of packets that FTP.transfer must handle, causing the transfer to take more time. However, the higher overhead also makes your application appear more responsive by allowing you to provide progress information to your users more frequently.

                

Examples:

ssCore.FTP.bufferSize({size:16384});