Tcl

Throttle FTP Transfer Bandwidth

Demonstrates the bandwidth properties BandwidthThrottleUp and BandwidthThrottleDown, and the read-only UploadTransferRate and DownloadTransferRate.

Note: The local paths are relative to the application's current working directory. Absolute paths may also be used. Supply the paths appropriate to your own environment.

Background: Throttling caps the approximate transfer rate in bytes per second (0 means unlimited), which is how a background sync avoids starving interactive traffic on a shared or metered link. The rate properties report the current measured throughput, updated during transfers, so you can display progress or confirm the throttle is taking effect. Treat the limits as approximate targets rather than hard ceilings.

Chilkat Tcl Downloads

Download Chilkat for Tcl

Tcl


load ./chilkat.dll

set success 0

set ftp [new_CkFtp2]

CkFtp2_put_Hostname $ftp "ftp.example.com"
CkFtp2_put_Username $ftp "myFtpLogin"

#  Limit the approximate transfer rate in bytes per second.  0 (the default) means no limit.
#  Throttling is useful to avoid saturating a shared link.
CkFtp2_put_BandwidthThrottleDown $ftp 1048576
CkFtp2_put_BandwidthThrottleUp $ftp 524288

#  Normally you would not hard-code the password in source.  You should instead obtain it
#  from an interactive prompt, environment variable, or a secrets vault.
CkFtp2_put_Password $ftp "myPassword"

set success [CkFtp2_Connect $ftp]
if {$success == 0} then {
    puts [CkFtp2_lastErrorText $ftp]
    delete_CkFtp2 $ftp
    exit
}

set success [CkFtp2_GetFile $ftp "public_html/bigfile.zip" "qa_output/bigfile.zip"]
if {$success == 0} then {
    puts [CkFtp2_lastErrorText $ftp]
    delete_CkFtp2 $ftp
    exit
}

#  The current average rates are updated during transfers.
puts "Download rate: [CkFtp2_get_DownloadTransferRate $ftp] bytes/sec"
puts "Upload rate: [CkFtp2_get_UploadTransferRate $ftp] bytes/sec"

set success [CkFtp2_Disconnect $ftp]
if {$success == 0} then {
    puts [CkFtp2_lastErrorText $ftp]
    delete_CkFtp2 $ftp
    exit
}


delete_CkFtp2 $ftp