DataFlex

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.) DataFlex

Use ChilkatAx-win32.pkg

Procedure Test
    Boolean iSuccess
    Handle hoSftp
    String sHostname
    Integer iPort
    String sRemoteFilePath
    String sLocalFilePath
    String sTemp1

    Move False To iSuccess

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

    Get Create (RefClass(cComChilkatSFtp)) To hoSftp
    If (Not(IsComObjectCreated(hoSftp))) Begin
        Send CreateComObject of hoSftp
    End

    // Set some timeouts, in milliseconds:
    Set ComConnectTimeoutMs Of hoSftp To 15000
    Set ComIdleTimeoutMs Of hoSftp To 15000

    // Connect to the SSH server.  
    // The standard SSH port = 22
    // The hostname may be a hostname or IP address.
    Move "sftp.example.com" To sHostname
    Move 22 To iPort
    Get ComConnect Of hoSftp sHostname iPort To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoSftp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Authenticate with the SSH server.  Chilkat SFTP supports
    // both password-based authenication as well as public-key
    // authentication.  This example uses password authenication.
    Get ComAuthenticatePw Of hoSftp "myLogin" "myPassword" To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoSftp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // After authenticating, the SFTP subsystem must be initialized:
    Get ComInitializeSftp Of hoSftp To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoSftp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Limit the transfer rate (bandwidth throttle) to 64K per second.
    Set ComBandwidthThrottleUp Of hoSftp To 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;
    Move "hamlet.xml" To sRemoteFilePath
    Move "c:/temp/hamlet.xml" To sLocalFilePath

    Get ComUploadFileByName Of hoSftp sRemoteFilePath sLocalFilePath To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoSftp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Showln "Success."


End_Procedure