IJournalFormat

1. Documentation
2. API reference
3. Microsoft.Orleans.Journaling
4. IJournalFormat

interface

Namespace: Orleans.Journaling

NuGetSourceMarkdown

Reads and writes the physical byte format used to persist state journal entries.

public interface IJournalFormat

Remarks

A journal format owns physical framing for entries. Durable state codecs write only the payload for a single entry.

Properties

• FormatKey Gets the key which identifies this journal format in storage metadata and keyed service registration.
• MimeType Gets the MIME type for journal storage written with this format, or null to use the storage provider's default.

Methods

• CreateWriter Creates a writer for a new mutable journal batch.
• Replay(JournalBufferReader, JournalReplayContext) Reads as many complete journal entries as possible from input and applies them to resolved states.