edtFTPnet/PRO - Secure FTP component for .NET | Free Trial | Pricing
Click or drag to resize

ConcurrentTransferSettings Class

Settings for controlling concurrent transfers.
Inheritance Hierarchy
SystemObject
  EnterpriseDT.Net.FtpConcurrentTransferSettings

Namespace:  EnterpriseDT.Net.Ftp
Assembly:  edtFTPnetPRO (in edtFTPnetPRO.dll) Version: 12.3.0.0
Syntax
Copy
public class ConcurrentTransferSettings

The ConcurrentTransferSettings type exposes the following members.

Properties
  NameDescription
Public propertyAutoRequeue
Automatically requeue tasks on connection-failure.
Public propertyEnabled
Determines whether or not concurrent transfers enabled.
Public propertyFallBackToMainConnection
Should the main connection be used if all connections in the pool fail?
Public propertyMaxConnections
Maximum number of connections to the server.
Public propertyPoolMode
Controls whether or not the main connection is included in the pool.
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString (Overrides ObjectToString.)
Top
Events
  NameDescription
Public eventPropertyChanged
Occurs when a property is changed.
Top
Remarks

When concurrent transfers are EnabledExFTPConnection (and SecureFTPConnection) will maintain a pool of up to MaxConnections-1 'slave' connections in addition to its own 'main' connection. Many servers limit the number of connections a single client may make to the server, so the number of active connections may be less than MaxConnections.

Interactive applications, such as traditional FTP client apps, can benefit from reserving one connection for user-actions, such as fetching directory listings. Thus when PoolMode is set to ReserveMainConnection the main connection will not usually be used for transfers. This is not an issue in non-interactive applications in which case the PoolMode may be set to UseMainConnection. The default value of PoolMode is Automatic where the main connection will used if ActiveForm is not null.

Although it's generally desirable to reserve the main connection for user interactivity in FTP client-type applications, this cannot be done if the server only permits one connection to the server. If FallBackToMainConnection is set to true (the default) then the main connection will be used for transfers if it is the only possible connection to the server.

If AutoRequeue is enabled then a task that has been given a failed connection will automatically be requeued if at least one connection is still operational.

See Also