EntglDb.Services.FileTransfer
2.3.0
.NET 10.0
This package targets .NET 10.0. The package is compatible with this framework or higher.
.NET Standard 2.1
This package targets .NET Standard 2.1. The package is compatible with this framework or higher.
dotnet add package EntglDb.Services.FileTransfer --version 2.3.0
NuGet\Install-Package EntglDb.Services.FileTransfer -Version 2.3.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="EntglDb.Services.FileTransfer" Version="2.3.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="EntglDb.Services.FileTransfer" Version="2.3.0" />
<PackageReference Include="EntglDb.Services.FileTransfer" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add EntglDb.Services.FileTransfer --version 2.3.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: EntglDb.Services.FileTransfer, 2.3.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package EntglDb.Services.FileTransfer@2.3.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=EntglDb.Services.FileTransfer&version=2.3.0
#tool nuget:?package=EntglDb.Services.FileTransfer&version=2.3.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
EntglDb.Services.FileTransfer
Peer-to-peer file transfer service for the EntglDb mesh network.
Allows any node to query metadata and stream file downloads from remote peers over the shared TCP connection, with automatic SHA-256 integrity verification.
What's Included
IFileProvider— server-side abstraction you implement to control which files are exposed (prevents path traversal)FileQueryHandler— responds to file-metadata queries (wire type 1100)FileDownloadHandler— streams file chunks to the requesting peer (wire type 1102), with SHA-256 hash computed on the flyIFileTransferService— client-side API withQueryAsyncandDownloadAsyncFileTransferIntegrityException— thrown if the received data does not match the server's checksum
Installation
dotnet add package EntglDb.Core
dotnet add package EntglDb.Network
dotnet add package EntglDb.Services.FileTransfer
Quick Start
1 — Implement IFileProvider (server side)
public class ReportFileProvider : IFileProvider
{
private static readonly Dictionary<string, string> _catalogue = new()
{
["report-q1"] = "/data/reports/q1-2026.pdf",
["report-q2"] = "/data/reports/q2-2026.pdf",
};
public Task<FileTransferInfo?> GetInfoAsync(string fileId, CancellationToken ct)
{
if (!_catalogue.TryGetValue(fileId, out var path) || !File.Exists(path))
return Task.FromResult<FileTransferInfo?>(null);
var fi = new System.IO.FileInfo(path);
return Task.FromResult<FileTransferInfo?>(new FileTransferInfo
{
FileId = fileId,
FileName = fi.Name,
SizeBytes = fi.Length,
});
}
public Task<Stream?> OpenReadAsync(string fileId, CancellationToken ct)
{
if (!_catalogue.TryGetValue(fileId, out var path) || !File.Exists(path))
return Task.FromResult<Stream?>(null);
return Task.FromResult<Stream?>(File.OpenRead(path));
}
}
2 — Register services
builder.Services
.AddEntglDbNetwork<MyConfigProvider>()
.AddEntglDbFileTransfer(); // registers handlers + IFileTransferService
builder.Services.AddSingleton<IFileProvider, ReportFileProvider>();
3 — Download a file from a peer
public class MyService
{
private readonly IFileTransferService _fileTransfer;
public MyService(IFileTransferService fileTransfer) => _fileTransfer = fileTransfer;
public async Task DownloadReportAsync(string peerAddress, CancellationToken ct)
{
// Check it exists first
var info = await _fileTransfer.QueryAsync(peerAddress, "report-q1", ct);
if (info is null) { Console.WriteLine("File not found on peer."); return; }
Console.WriteLine($"Downloading {info.FileName} ({info.SizeBytes:N0} bytes)...");
using var fs = File.OpenWrite("report-q1.pdf");
await _fileTransfer.DownloadAsync(peerAddress, "report-q1", fs, ct);
Console.WriteLine("Done. SHA-256 verified.");
}
}
Wire Protocol
| Type | Value | Direction | Description |
|---|---|---|---|
FileQueryReq |
1100 | client → server | Ask if file exists |
FileQueryRes |
1101 | server → client | Metadata or not-found |
FileDownloadReq |
1102 | client → server | Start download |
FileChunkMsg |
1103 | server → client | Binary chunk (repeating) |
FileTransferDoneMsg |
1104 | server → client | End-of-stream + SHA-256 |
Documentation
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
| .NET Core | netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
| .NET Standard | netstandard2.1 is compatible. |
| MonoAndroid | monoandroid was computed. |
| MonoMac | monomac was computed. |
| MonoTouch | monotouch was computed. |
| Tizen | tizen60 was computed. |
| Xamarin.iOS | xamarinios was computed. |
| Xamarin.Mac | xamarinmac was computed. |
| Xamarin.TVOS | xamarintvos was computed. |
| Xamarin.WatchOS | xamarinwatchos was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
.NETStandard 2.1
- EntglDb.Network (>= 2.3.0)
- Google.Protobuf (>= 3.34.1)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 10.0.5)
- Microsoft.Extensions.Logging.Abstractions (>= 10.0.5)
-
net10.0
- EntglDb.Network (>= 2.3.0)
- Google.Protobuf (>= 3.34.1)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 10.0.5)
- Microsoft.Extensions.Logging.Abstractions (>= 10.0.5)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
| Version | Downloads | Last Updated |
|---|---|---|
| 2.3.0 | 24 | 3/26/2026 |