Class SftpDownloadAsyncResult

Namespace

Renci.SshNet.Sftp

Assembly

Renci.SshNet.dll

Encapsulates the results of an asynchronous download operation.

public class SftpDownloadAsyncResult : AsyncResult, IAsyncResult

Inheritance

object

AsyncResult

SftpDownloadAsyncResult

Implements

IAsyncResult

Inherited Members

AsyncResult.SetAsCompleted(Exception, bool)

AsyncResult.EndInvokeCalled

AsyncResult.AsyncState

AsyncResult.CompletedSynchronously

AsyncResult.AsyncWaitHandle

AsyncResult.IsCompleted

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

SftpDownloadAsyncResult(AsyncCallback, object)

Initializes a new instance of the SftpDownloadAsyncResult class.

public SftpDownloadAsyncResult(AsyncCallback asyncCallback, object state)

Parameters

asyncCallback AsyncCallback

The async callback.

state object

The state.

Properties

DownloadedBytes

Gets the number of downloaded bytes.

public ulong DownloadedBytes { get; }

Property Value

ulong

IsDownloadCanceled

Gets or sets a value indicating whether to cancel asynchronous download operation.

public bool IsDownloadCanceled { get; set; }

Property Value

bool

true if download operation to be canceled; otherwise, false.

Remarks

Download operation will be canceled after finishing uploading current buffer.