Xojo Plugin

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 Xojo Plugin Downloads

Download Chilkat for Xojo Plugin

Xojo Plugin

Dim success As Boolean
success = False

//  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.

Dim sftp As New Chilkat.SFtp

//  Step 1: Connect the SSH transport.  Port 22 is the usual port.
Dim port As Int32
port = 22
success = sftp.Connect("sftp.example.com",port)
If (success = False) Then
    System.DebugLog(sftp.LastErrorText)
    Return
End If

//  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.
Dim password As String
password = "mySshPassword"

success = sftp.AuthenticatePw("mySshLogin",password)
If (success = False) Then
    System.DebugLog(sftp.LastErrorText)
    Return
End If

//  Step 3: Open the SFTP subsystem.  This must be done after authentication and before any
//  file or directory operations.
success = sftp.InitializeSftp()
If (success = False) Then
    System.DebugLog(sftp.LastErrorText)
    Return
End If

//  Send an IGNORE message to verify the connection is still writable.
success = sftp.SendIgnore()
If (success = False) Then
    System.DebugLog(sftp.LastErrorText)
    Return
End If

System.DebugLog("IGNORE message sent.")

sftp.Disconnect