Skip to content

Automatic Reconnection

Robin Rodricks edited this page Jun 14, 2023 · 14 revisions

API

Tip: For detailed documentation refer to the IntelliSense tips that appear when you call a given API method.

  • DiscoverSslSessionLength() - Automatically discover the optimal setting value for SslSessionLength. Returns the number that must be stored in your application's source code or config file, and then passed to SslSessionLength at a later time.

Settings

  • Config.SslSessionLength - Number of FTP responses after which we automatically reconnect to the FTP server. Only honored for SSL connections, and ignored for plaintext FTP connections. Set it to 0 to disable automatic reconnection. Default: 750.

How does automatic reconnection work?

At various intervals, we need to reconnect to the FTP server automatically.

  • The FTP server has disconnected us in-between a file transfer, so we need to reconnect and resume the file transfer.
  • We predict that the FTPS connection will get corrupted due to OS bugs, so to prevent this, we preemptively disconnect and reconnect on our own.

FTP Server disconnects midway

This happens during upload and download, and is handled within UploadFileInternal (sync/async) and DownloadFileInternal (sync/async).

These functions detect if the FTP connection was lost and automatically try to reconnect and resume the transfer.

It is always enabled and does not require configuration as such.

FTP Connection gets corrupted

This is only needed and enabled for FTPS/SSL connections and not for plaintext FTP.

We noticed that the underlying .NET SSL stream gets "corrupted" (goes into a unrecoverable state and throws an IOException) after around 900 FTP responses are received from the server. So we developed this system to bypass this limitation: we count the FTP responses received, and then pre-emptively disconnect and reconnect to the FTP server. Please note that this is a bug in the .NET runtime and not with FluentFTP.

It is enabled by default but can be disabled. You can configure it using the setting Config.SslSessionLength (docs above).

reconnect diagram

How do I calculate the best value for these settings?

You can use code similar to this to calibrate the best value for your FTP server.

Once you get the value, save it in your application's source code or config file, and then manually set it into SslSessionLength at runtime.

using (var client = new FtpClient("ftp://xxx.com/", "xxx", "xxx")){
    client.Config.EncryptionMode = FtpEncryptionMode.Explicit;
    client.Config.ValidateAnyCertificate = true;
    int maxSslCommandLimit = client.DiscoverSslSessionLength();
    Console.WriteLine("Set SslSessionLength to less than: " + maxSslCommandLimit);
}
Clone this wiki locally