Interface IBackgroundTransferWorker

A background transfer worker.

Namespace: FubarDev.FtpServer.BackgroundTransfer
Assembly: FubarDev.FtpServer.Abstractions.dll
Syntax
public interface IBackgroundTransferWorker

Methods

| Improve this Doc View Source

EnqueueAsync(IBackgroundTransfer, CancellationToken)

Enqueue an entry for a background transfer (e.g. upload).

Declaration
Task EnqueueAsync(IBackgroundTransfer backgroundTransfer, CancellationToken cancellationToken)
Parameters
Type Name Description
IBackgroundTransfer backgroundTransfer

The background transfer to enqueue.
CancellationToken cancellationToken

The cancellation token.
Returns
Type Description
Task

The task.
| Improve this Doc View Source

GetStates()

Get the status of all pending and active background transfers.

Declaration
IReadOnlyCollection<BackgroundTransferInfo> GetStates()
Returns
Type Description
IReadOnlyCollection<BackgroundTransferInfo>

The status of all background transfers.