PureBasic

Monitor FTP Transfer Progress

Demonstrates the progress properties CurBytesReceived, CurBytesReceivedStr, CurBytesSent, CurBytesSentStr, ProgressMonSize, PercentDoneScale, and AutoGetSizeForProgress.

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: Percentage progress needs a known total, but FTP does not always report a file's size up front — so AutoGetSizeForProgress issues a SIZE command before a download, and ProgressMonSize supplies an expected size when even that is unavailable (a one-shot value consumed by the next transfer). PercentDoneScale sets the resolution of progress callbacks. The current byte counts are exposed both as 32-bit integers and as strings, the string forms avoiding integer-width limits for very large transfers.

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")

    ;  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

    ;  AutoGetSizeForProgress sends a SIZE command before a download so percentage-based progress can
    ;  be computed.
    CkFtp2::setCkAutoGetSizeForProgress(ftp, 1)

    ;  PercentDoneScale sets the value representing one hundred percent in PercentDone callbacks.
    ;  1000 gives tenth-of-a-percent resolution.
    CkFtp2::setCkPercentDoneScale(ftp, 1000)

    ;  ProgressMonSize is a one-shot expected size for the next download when the size is not
    ;  otherwise known.  It is consumed by the next download and reset to 0.
    CkFtp2::setCkProgressMonSize(ftp, 20485760)

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

    ;  After a transfer, the current byte counts are available as 32-bit numbers or as strings (the
    ;  string forms avoid integer-size limits).
    Debug "Bytes received: " + Str(CkFtp2::ckCurBytesReceived(ftp))
    Debug "Bytes received (str): " + CkFtp2::ckCurBytesReceivedStr(ftp)
    Debug "Bytes sent: " + Str(CkFtp2::ckCurBytesSent(ftp))
    Debug "Bytes sent (str): " + CkFtp2::ckCurBytesSentStr(ftp)

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



    CkFtp2::ckDispose(ftp)


    ProcedureReturn
EndProcedure