AutoIt

Enable FTP MODE Z Compression

Demonstrates the Chilkat Ftp2.SetModeZ method, which enables MODE Z compression for subsequent data connections. It takes no arguments. Call it after connecting and only when the HasModeZ property is true.

Background: MODE Z compresses data on the fly (using zlib) as it crosses the wire, which can meaningfully speed up transfers of compressible content — text, HTML, logs — over a slow link. It is a server extension, so check HasModeZ first and expect it to be unavailable on many servers. There is little benefit for already-compressed data such as images or archives, where the CPU cost of compression buys almost nothing.

Chilkat AutoIt Downloads

Download Chilkat for AutoIt

AutoIt

Local $bSuccess = False

;  Demonstrates the Ftp2.SetModeZ method, which enables MODE Z compression for subsequent data
;  connections.  It takes no arguments.  Call it after connecting, and only when the HasModeZ
;  property indicates the server supports it.

$oFtp = ObjCreate("Chilkat.Ftp2")

$oFtp.Hostname = "ftp.example.com"
$oFtp.Username = "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.
$oFtp.Password = "myPassword"

$bSuccess = $oFtp.Connect()
If ($bSuccess = False) Then
    ConsoleWrite($oFtp.LastErrorText & @CRLF)
    Exit
EndIf

$bSuccess = $oFtp.ChangeRemoteDir("public_html")
If ($bSuccess = False) Then
    ConsoleWrite($oFtp.LastErrorText & @CRLF)
    Exit
EndIf

;  Only enable compression if the server advertises MODE Z support.
If ($oFtp.HasModeZ) Then
    $bSuccess = $oFtp.SetModeZ()
    If ($bSuccess = False) Then
        ConsoleWrite($oFtp.LastErrorText & @CRLF)
        Exit
    EndIf

    ConsoleWrite("MODE Z compression enabled." & @CRLF)
Else
    ConsoleWrite("The server does not support MODE Z." & @CRLF)
EndIf

;  Subsequent uploads, downloads, and listings are transferred compressed.

$bSuccess = $oFtp.Disconnect()
If ($bSuccess = False) Then
    ConsoleWrite($oFtp.LastErrorText & @CRLF)
    Exit
EndIf