Class DownloadFile

Namespace

NanoByte.Common.Net

Assembly

NanoByte.Common.dll

Downloads a file from a specific internet address to a stream.

public class DownloadFile : TaskBase, ITask

Inheritance

object

MarshalByRefObject

TaskBase

DownloadFile

Implements

ITask

Inherited Members

TaskBase.Tag

TaskBase.CanCancel

TaskBase.PreventIdle

TaskBase.CancellationToken

TaskBase.CredentialProvider

TaskBase.Run(CancellationToken, ICredentialProvider, IProgress<TaskSnapshot>)

TaskBase.State

TaskBase.UnitsProcessed

TaskBase.UnitsTotal

Extension Methods

BinaryStorage.SaveBinary<T>(T, Stream)

BinaryStorage.SaveBinary<T>(T, string)

JsonStorage.SaveJson<T>(T, Stream)

JsonStorage.SaveJson<T>(T, string)

JsonStorage.ToJsonString<T>(T)

XmlStorage.SaveXml<T>(T, string, string?)

UpdateUtils.To<TIn, TOut>(TIn, Func<TIn, TOut>)

ConversionUtils.ConvertToString<TType>(TType)

JsonStorage.ReparseAsJson<T>(object)

JsonStorage.ReparseAsJson<T>(object, T)

XmlStorage.SaveXml(object, Stream, string?)

XmlStorage.ToXmlString(object, string?)

Constructors

DownloadFile(Uri, Action<Stream>, long)

Creates a new download task.

public DownloadFile(Uri source, Action<Stream> callback, long bytesTotal = -1)

Parameters

source Uri

The URL the file is to be downloaded from.

callback Action<Stream>

Called with a stream providing the download content.

bytesTotal long

The number of bytes the file to be downloaded is long. The file will be rejected if it does not have this length. -1 if the size is unknown.

DownloadFile(Uri, string, long)

Creates a new download task.

public DownloadFile(Uri source, string target, long bytesTotal = -1)

Parameters

source Uri

The URL the file is to be downloaded from.

target string

The local path to save the file to. A preexisting file will be overwritten.

bytesTotal long

The number of bytes the file to be downloaded is long. The file will be rejected if it does not have this length. -1 if the size is unknown.

Properties

BytesMaximum

The maximum number of bytes to download.

public long BytesMaximum { get; set; }

Property Value

long

ContentStarted

Indicates whether the server has started sending content.

public bool ContentStarted { get; }

Property Value

bool

Name

A name describing the task in human-readable form.

public override string Name { get; }

Property Value

string

NoCache

Set to true to add a No-Cache header to the request for any intermediate proxy servers.

public bool NoCache { get; set; }

Property Value

bool

Source

The URL the file is to be downloaded from.

public Uri Source { get; }

Property Value

Uri

Remarks

This value may change once Data has been reached, based on HTTP redirections.

UnitsByte

true if UnitsProcessed and UnitsTotal are measured in bytes; false if they are measured in generic units.

protected override bool UnitsByte { get; }

Property Value

bool

Methods

Execute()

The actual code to be executed.

protected override void Execute()

Remarks

State is automatically set to Started before calling this method, to Complete after a successful exit and to an appropriate error state in case on an exception. You can set additional TaskStates during execution.

Exceptions

OperationCanceledException

The operation was canceled.

IOException

The task ended with IOError.

WebException

The task ended with WebError.