Pascal (Lazarus/Delphi)

SFTP Upload with Bandwidth Throttling

Demonstrates how to upload a file to an SSH server in the simplest way with bandwidth throttling. Bandwidth throttling for all SFTP communications can be achieved by simply setting the BandwidthThrottleUp or BandwidthThrottleDown properties. (One limits the transfer rate for uploads, the other for downloads.) Pascal (Lazarus/Delphi)

program ChilkatDemo;

// Demonstrates using the Chilkat Pascal wrapper via the C bridge DLL.
// Builds as a console application under Lazarus (FPC) or Delphi.

{$IFDEF FPC}
  {$MODE DELPHI}
{$ENDIF}
{$APPTYPE CONSOLE}

uses
  {$IFDEF UNIX}
  cthreads,
  {$ENDIF}
  SysUtils,
  CkDllLoader,
  Chilkat.SFtp;

// ---------------------------------------------------------------------------

procedure RunDemo;
var
  success: Boolean;
  sftp: TSFtp;
  hostname: string;
  port: Integer;
  remoteFilePath: string;
  localFilePath: string;

begin
  success := False;

  //  This example assumes the Chilkat API to have been previously unlocked.
  //  See Global Unlock Sample for sample code.

  sftp := TSFtp.Create;

  //  Set some timeouts, in milliseconds:
  sftp.ConnectTimeoutMs := 15000;
  sftp.IdleTimeoutMs := 15000;

  //  Connect to the SSH server.  
  //  The standard SSH port = 22
  //  The hostname may be a hostname or IP address.
  hostname := 'sftp.example.com';
  port := 22;
  success := sftp.Connect(hostname,port);
  if (success <> True) then
    begin
      WriteLn(sftp.LastErrorText);
      Exit;
    end;

  //  Authenticate with the SSH server.  Chilkat SFTP supports
  //  both password-based authenication as well as public-key
  //  authentication.  This example uses password authenication.
  success := sftp.AuthenticatePw('myLogin','myPassword');
  if (success <> True) then
    begin
      WriteLn(sftp.LastErrorText);
      Exit;
    end;

  //  After authenticating, the SFTP subsystem must be initialized:
  success := sftp.InitializeSftp();
  if (success <> True) then
    begin
      WriteLn(sftp.LastErrorText);
      Exit;
    end;

  //  Limit the transfer rate (bandwidth throttle) to 64K per second.
  sftp.BandwidthThrottleUp := 65536;

  //  Upload from the local file to the SSH server.
  //  Important -- the remote filepath is the 1st argument,
  //  the local filepath is the 2nd argument;
  remoteFilePath := 'hamlet.xml';
  localFilePath := 'c:/temp/hamlet.xml';

  success := sftp.UploadFileByName(remoteFilePath,localFilePath);
  if (success <> True) then
    begin
      WriteLn(sftp.LastErrorText);
      Exit;
    end;

  WriteLn('Success.');


  sftp.Free;

end;

// ---------------------------------------------------------------------------

begin

  try
    RunDemo;
  except
    on E: Exception do
      WriteLn('Unhandled exception: ', E.ClassName, ': ', E.Message);
  end;

  WriteLn;
  {$IFDEF MSWINDOWS}
  WriteLn('Press Enter to exit...');
  ReadLn;
  {$ENDIF}
end.