PureBasic

FTP Bandwidth Throttle for Downloads

See more FTP Examples

Demonstrates the Chilkat FTP2 download bandwidth throttling property : BandwidthThrottleDown. PureBasic

IncludeFile "CkFtp2.pb"

Procedure ChilkatExample()

    success.i = 0

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

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

    CkFtp2::setCkHostname(ftp, "ftp.example.com")
    CkFtp2::setCkUsername(ftp, "login")
    CkFtp2::setCkPassword(ftp, "password")

    ; To use FTP bandwidth throttling, set the BandwidthThrottleDown
    ; property to a maximum desired bytes/second:
    ; This example limits the download to 50K per second.
    CkFtp2::setCkBandwidthThrottleDown(ftp, 50000)

    ; The default data transfer mode is "Active" as opposed to "Passive".

    ; Connect and login to the FTP server.
    success = CkFtp2::ckConnect(ftp)
    If success <> 1
        Debug CkFtp2::ckLastErrorText(ftp)
        CkFtp2::ckDispose(ftp)
        ProcedureReturn
    EndIf

    ; Change to the remote directory where the file is located.
    ; This step is only necessary if the file is not in the root directory
    ; for the FTP account.
    success = CkFtp2::ckChangeRemoteDir(ftp,"junk")
    If success <> 1
        Debug CkFtp2::ckLastErrorText(ftp)
        CkFtp2::ckDispose(ftp)
        ProcedureReturn
    EndIf

    ; Download a file.
    localFilename.s = "hamlet.xml"
    remoteFilename.s = "hamlet.xml"

    success = CkFtp2::ckGetFile(ftp,remoteFilename,localFilename)
    If success <> 1
        Debug CkFtp2::ckLastErrorText(ftp)
        CkFtp2::ckDispose(ftp)
        ProcedureReturn
    EndIf

    success = CkFtp2::ckDisconnect(ftp)

    Debug "File Downloaded!"


    CkFtp2::ckDispose(ftp)


    ProcedureReturn
EndProcedure