PureBasic

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 PureBasic Downloads

Download Chilkat for PureBasic

PureBasic

IncludeFile "CkFtp2.pb"

Procedure ChilkatExample()

    success.i = 0

    ftp.i = CkFtp2::ckCreate()
    If ftp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkFtp2::setCkHostname(ftp, "ftp.example.com")
    CkFtp2::setCkUsername(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::setCkBandwidthThrottleDown(ftp, 1048576)
    CkFtp2::setCkBandwidthThrottleUp(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::setCkPassword(ftp, "myPassword")

    success = CkFtp2::ckConnect(ftp)
    If success = 0
        Debug CkFtp2::ckLastErrorText(ftp)
        CkFtp2::ckDispose(ftp)
        ProcedureReturn
    EndIf

    success = CkFtp2::ckGetFile(ftp,"public_html/bigfile.zip","qa_output/bigfile.zip")
    If success = 0
        Debug CkFtp2::ckLastErrorText(ftp)
        CkFtp2::ckDispose(ftp)
        ProcedureReturn
    EndIf

    ;  The current average rates are updated during transfers.
    Debug "Download rate: " + Str(CkFtp2::ckDownloadTransferRate(ftp)) + " bytes/sec"
    Debug "Upload rate: " + Str(CkFtp2::ckUploadTransferRate(ftp)) + " bytes/sec"

    success = CkFtp2::ckDisconnect(ftp)
    If success = 0
        Debug CkFtp2::ckLastErrorText(ftp)
        CkFtp2::ckDispose(ftp)
        ProcedureReturn
    EndIf



    CkFtp2::ckDispose(ftp)


    ProcedureReturn
EndProcedure