Interface IFileTransferInformation

The File transfer interface

Inherited Members
System.IDisposable.Dispose()
Namespace: Catalyst.Abstractions.FileTransfer
Assembly: Catalyst.Abstractions.dll
Syntax
public interface IFileTransferInformation : IDisposable

Properties

| Improve this Doc View Source

CancellationToken

The cancellation token

Declaration
CancellationToken CancellationToken { get; set; }
Property Value
Type Description
System.Threading.CancellationToken
| Improve this Doc View Source

CorrelationId

Gets or sets the name of the unique file.

Declaration
ICorrelationId CorrelationId { get; set; }
Property Value
Type Description
ICorrelationId

The name of the unique file.
| Improve this Doc View Source

DfsHash

Gets or sets the DFS hash.

Declaration
string DfsHash { get; set; }
Property Value
Type Description
System.String

The DFS hash.
| Improve this Doc View Source

FileOutputPath

Gets or sets the file output path.

Declaration
string FileOutputPath { get; set; }
Property Value
Type Description
System.String

The file output path.
| Improve this Doc View Source

Initialised

Gets or sets a value indicating whether this IFileTransferInformation is initialised.

Declaration
bool Initialised { get; set; }
Property Value
Type Description
System.Boolean

true if initialised; otherwise, false.
| Improve this Doc View Source

IsCompleted

Gets or sets a value indicating whether this instance is completed.

Declaration
bool IsCompleted { get; set; }
Property Value
Type Description
System.Boolean

true if this instance is completed; otherwise, false.
| Improve this Doc View Source

MaxChunk

Gets the maximum chunk.

Declaration
uint MaxChunk { get; }
Property Value
Type Description
System.UInt32

The maximum chunk.
| Improve this Doc View Source

PeerId

Gets or sets the peer identifier.

Declaration
PeerId PeerId { get; set; }
Property Value
Type Description
PeerId

The peer identifier.
| Improve this Doc View Source

RecipientChannel

Gets or sets the recipient channel.

Declaration
IChannel RecipientChannel { get; set; }
Property Value
Type Description
IChannel

The recipient channel.
| Improve this Doc View Source

RecipientId

Gets or sets the recipient identifier.

Declaration
PeerId RecipientId { get; set; }
Property Value
Type Description
PeerId

The recipient identifier.
| Improve this Doc View Source

TempPath

Gets the temporary path.

Declaration
string TempPath { get; }
Property Value
Type Description
System.String

The temporary path.

Methods

| Improve this Doc View Source

ChunkIndicatorsTrue()

Chunks the indicators true.

Declaration
bool ChunkIndicatorsTrue()
Returns
Type Description
System.Boolean
| Improve this Doc View Source

CleanUp()

Cleans up.

Declaration
void CleanUp()
| Improve this Doc View Source

Delete()

Deletes the file.

Declaration
void Delete()
| Improve this Doc View Source

Expire()

Expires this instance.

Declaration
void Expire()
| Improve this Doc View Source

GetPercentage()

Gets the percentage.

Declaration
int GetPercentage()
Returns
Type Description
System.Int32
| Improve this Doc View Source

IsExpired()

Determines whether this instance is expired.

Declaration
bool IsExpired()
Returns
Type Description
System.Boolean

true if this instance is expired; otherwise, false.
| Improve this Doc View Source

UpdateChunkIndicator(UInt32, Boolean)

Updates the chunk indicator.

Declaration
void UpdateChunkIndicator(uint chunkId, bool state)
Parameters
Type Name Description
System.UInt32 chunkId

The chunk identifier.
System.Boolean state

if set to true [state].