PureBasic

Send an FTP NOOP (Keep-Alive)

Demonstrates the Chilkat Ftp2.Noop method, which sends the FTP NOOP command. It takes no arguments and succeeds only when the server returns a positive reply.

Background: NOOP asks the server to do nothing and simply reply, which makes it the standard keep-alive: sending one periodically resets the server's idle timer so a long-running job does not lose its control connection between transfers. Because it exercises a real request/reply round trip, a successful NOOP is also firmer evidence the connection is alive than CheckConnection.

Chilkat PureBasic Downloads

Download Chilkat for PureBasic

PureBasic

IncludeFile "CkFtp2.pb"

Procedure ChilkatExample()

    success.i = 0

    ;  Demonstrates the Ftp2.Noop method, which sends the FTP NOOP command.  It takes no arguments.
    ;  The server must return a positive reply for the method to succeed.

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

    ;  Connect and log in (Connect performs both).
    success = CkFtp2::ckConnect(ftp)
    If success = 0
        Debug CkFtp2::ckLastErrorText(ftp)
        CkFtp2::ckDispose(ftp)
        ProcedureReturn
    EndIf

    ;  NOOP does nothing on the server, but a successful reply confirms the control connection is
    ;  still responsive -- useful as a keep-alive during an otherwise idle session.
    success = CkFtp2::ckNoop(ftp)
    If success = 0
        Debug CkFtp2::ckLastErrorText(ftp)
        CkFtp2::ckDispose(ftp)
        ProcedureReturn
    EndIf

    Debug "NOOP acknowledged by the server."

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



    CkFtp2::ckDispose(ftp)


    ProcedureReturn
EndProcedure