Rymote.Synapse.Persistence.File 1.0.0

.NET 10.0

dotnet add package Rymote.Synapse.Persistence.File --version 1.0.0

NuGet\Install-Package Rymote.Synapse.Persistence.File -Version 1.0.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="Rymote.Synapse.Persistence.File" Version="1.0.0" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="Rymote.Synapse.Persistence.File" Version="1.0.0" />
                    

                            Directory.Packages.props

<PackageReference Include="Rymote.Synapse.Persistence.File" />
                    

                            Project file

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 Rymote.Synapse.Persistence.File --version 1.0.0

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: Rymote.Synapse.Persistence.File, 1.0.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 Rymote.Synapse.Persistence.File@1.0.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=Rymote.Synapse.Persistence.File&version=1.0.0
                    

                            Install as a Cake Addin

#tool nuget:?package=Rymote.Synapse.Persistence.File&version=1.0.0
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Rymote.Synapse.Persistence.File

Disk-backed IMessageLog for Rymote.Synapse. Enables AtLeastOnce semantics that survive process restarts.

What it provides

Segment-based append-only log on disk
Group-commit fsync for write durability
Ack-driven segment compaction — disk usage bounded by unacked backlog, not lifetime publish count
Sidecar cursor file with periodic flush
Single-writer per data directory (lock file enforced)
Crash-recovery: tail truncation at corruption boundary on startup
Pure .NET (no native dependencies)

Quickstart

services.AddSynapse(options => options.NodeIdentity = NodeIdentity.NewIdentity())
    .UseMessagePackSerialization()
    .UseFilePersistence(file =>
    {
        file.DataDirectory = "/var/lib/synapse/log";
        file.SegmentSizeBytes = 128L * 1024 * 1024;
        file.WriteCoalescingInterval = TimeSpan.FromMilliseconds(5);
        file.CursorFlushInterval = TimeSpan.FromMilliseconds(100);
    })
    .UseTcpTransport(...)
    .UseCluster();

Durability semantics

PublishAsync for AtLeastOnce-policy messages returns only after the record is on disk (fsync'd via group commit).
Subscription cursors are flushed periodically (default every 100 ms); on crash the last interval's worth of acks may be lost, causing bounded redelivery — consistent with AtLeastOnce.
A LOCK file is created at the data directory; a second process attempting to open the same directory throws LogStorageException.

Tuning

Option	Default	Notes
`SegmentSizeBytes`	64 MiB	Smaller = more frequent rolls, faster compaction granularity; larger = fewer files.
`WriteCoalescingInterval`	5 ms	Upper bound on publish latency under low load.
`WriteCoalescingMaxBatchSize`	1024	Cap on group-commit batch.
`CursorFlushInterval`	100 ms	Trade-off between redelivery window and ack throughput.
`MaxRecordSizeBytes`	16 MiB	Hard cap on individual envelope size.

What it doesn't do

No multi-process writers — single-process per data directory.
No replication — clustering provides cross-node redundancy.
No format compatibility commitment across major versions.
No queryable index — the log is a stream, not a database.

Product	Compatible and additional computed target framework versions.
.NET	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.

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net10.0
- MessagePack (>= 2.5.187)
- Microsoft.Extensions.DependencyInjection (>= 10.0.0)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 10.0.0)
- Microsoft.Extensions.Logging.Abstractions (>= 10.0.0)
- Rymote.Synapse.Abstractions (>= 1.0.0)
- Rymote.Synapse.Core (>= 1.0.0)
- System.IO.Hashing (>= 10.0.0)

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
1.0.0	116	5/18/2026