(Tcl) SFTP Upload with Bandwidth Throttling

Demonstrates how to upload a file to an SSH server in the simplest way with bandwidth throttling. Bandwidth throttling for all SFTP communications can be achieved by simply setting the BandwidthThrottleUp or BandwidthThrottleDown properties. (One limits the transfer rate for uploads, the other for downloads.)

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

set sftp [new_CkSFtp]

# Set some timeouts, in milliseconds:
CkSFtp_put_ConnectTimeoutMs $sftp 15000
CkSFtp_put_IdleTimeoutMs $sftp 15000

# Connect to the SSH server.  
# The standard SSH port = 22
# The hostname may be a hostname or IP address.
set hostname "sftp.example.com"
set port 22
set success [CkSFtp_Connect $sftp $hostname $port]
if {$success != 1} then {
    puts [CkSFtp_lastErrorText $sftp]
    delete_CkSFtp $sftp
    exit
}

# Authenticate with the SSH server.  Chilkat SFTP supports
# both password-based authenication as well as public-key
# authentication.  This example uses password authenication.
set success [CkSFtp_AuthenticatePw $sftp "myLogin" "myPassword"]
if {$success != 1} then {
    puts [CkSFtp_lastErrorText $sftp]
    delete_CkSFtp $sftp
    exit
}

# After authenticating, the SFTP subsystem must be initialized:
set success [CkSFtp_InitializeSftp $sftp]
if {$success != 1} then {
    puts [CkSFtp_lastErrorText $sftp]
    delete_CkSFtp $sftp
    exit
}

# Limit the transfer rate (bandwidth throttle) to 64K per second.
CkSFtp_put_BandwidthThrottleUp $sftp 65536

# Upload from the local file to the SSH server.
# Important -- the remote filepath is the 1st argument,
# the local filepath is the 2nd argument;
set remoteFilePath "hamlet.xml"
set localFilePath "c:/temp/hamlet.xml"

set success [CkSFtp_UploadFileByName $sftp $remoteFilePath $localFilePath]
if {$success != 1} then {
    puts [CkSFtp_lastErrorText $sftp]
    delete_CkSFtp $sftp
    exit
}

puts "Success."

delete_CkSFtp $sftp