Xbase++

Send an SSH IGNORE Message over SFTP

Demonstrates the Chilkat SFtp.SendIgnore method, which sends an SSH IGNORE message. It takes no arguments. The server sends no reply, but a successful send helps confirm the connection is still writable. No SFTP file handle is required.

Background: The SSH IGNORE message is discarded by the peer by design; its value is as a lightweight keep-alive or liveness probe. During a long-idle SFTP session — for instance while waiting between scheduled transfers — a periodic SendIgnore both keeps the connection from being dropped for inactivity and proves the link is still usable, without touching any file.

Chilkat Xbase++ Downloads

Download Chilkat for Xbase++

Xbase++

LOCAL nSuccess
LOCAL oSftp
LOCAL nPort
LOCAL cPassword

nSuccess := 0

//  Demonstrates the SFtp.SendIgnore method, which sends an SSH IGNORE message.  It takes no
//  arguments.  The server sends no reply, but a successful send helps confirm the connection is
//  still writable.  No SFTP file handle is required.

oSftp := CreateObject("Chilkat.SFtp")

//  Step 1: Connect the SSH transport.  Port 22 is the usual port.
nPort := 22
nSuccess := oSftp:Connect("sftp.example.com", nPort)
IF (nSuccess == 0)
    ? oSftp:LastErrorText
    oSftp:destroy()
    RETURN
ENDIF

//  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.
cPassword := "mySshPassword"

nSuccess := oSftp:AuthenticatePw("mySshLogin", cPassword)
IF (nSuccess == 0)
    ? oSftp:LastErrorText
    oSftp:destroy()
    RETURN
ENDIF

//  Step 3: Open the SFTP subsystem.  This must be done after authentication and before any
//  file or directory operations.
nSuccess := oSftp:InitializeSftp()
IF (nSuccess == 0)
    ? oSftp:LastErrorText
    oSftp:destroy()
    RETURN
ENDIF

//  Send an IGNORE message to verify the connection is still writable.
nSuccess := oSftp:SendIgnore()
IF (nSuccess == 0)
    ? oSftp:LastErrorText
    oSftp:destroy()
    RETURN
ENDIF

? "IGNORE message sent."

oSftp:Disconnect()

oSftp:destroy()