Interface IBackgroundTransfer

Interface for background data transfers.

Inherited Members
Namespace: FubarDev.FtpServer.BackgroundTransfer
Assembly: FubarDev.FtpServer.Abstractions.dll
Syntax
public interface IBackgroundTransfer : IDisposable

Properties

| Improve this Doc View Source

TransferId

Gets the ID of the background data transfer.

Declaration
string TransferId { get; }
Property Value
Type Description
String

Methods

| Improve this Doc View Source

Start(IProgress<Int64>, CancellationToken)

Starts the background data transfer.

Declaration
Task Start(IProgress<long> progress, CancellationToken cancellationToken)
Parameters
Type Name Description
IProgress<Int64> progress

Used to send the progress to the caller.
CancellationToken cancellationToken

The cancellation token used to abort the background data transfer.
Returns
Type Description
Task

The task used to transfer the data in the background.