Skip to content

Microsoft.Orleans.Durable

10.0.0-alpha.1 · net11.0

Orleans

Orleans.Configuration

Orleans.Durable.Jobs

DurableJob

class
Represents a durable job that will be executed at a specific time.

IDurableJobHandler

interface
Defines the interface for handling durable job execution. Grains implement this interface to receive and process durable jobs.

IJobRunContext

interface
Provides contextual information about a durable job execution.

IJobShard

interface
Represents a shard of durable jobs that manages a collection of jobs within a specific time range. A job shard is responsible for storing, retrieving, and managing the lifecycle of durable jobs that fall within its designated time window.

JobShard

class
Base implementation of IJobShard that provides common functionality for job shard implementations.

JobShardManager

class
Manages the lifecycle of job shards for a specific silo.

Orleans.Durable.Journaling

DurableGrain

class
Provides convenience methods for grains which manage journaled durable state.

IDurableList<T>

interface
Represents a list whose mutations are recorded in a journal.

IDurableLog<T>

interface
Represents an append-only, observable log whose entries are recorded in a journal.

IDurableLogDraft<T>

interface
Streams volatile items to the readers of an Orleans.Durable.Journaling.IDurableLog which include drafts, until the draft commits durable entries or is abandoned.

IDurableQueue<T>

interface
Represents a first-in, first-out collection whose mutations are recorded in a journal.

IDurableSet<T>

interface
Represents a set whose mutations are recorded in a journal.

IDurableStateManager

interface
Manages a grain's durable state, whose named components share a journal and write acknowledgement boundary.

IDurableValue<T>

interface
Represents a value whose changes are recorded in a journal.

IJournalFormat

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

IPreservedJournalEntry

interface
A format-owned journal entry which can be copied forward without interpreting it.

IStateMachine

interface
Defines the replay, snapshot, and acknowledgement protocol for a journal-backed state machine.

JournalBufferWriter

class
Base class for in-memory journal buffers used to assemble a pending journal batch.

JournalCatalogEntry

struct
A journal identity and an optional metadata snapshot returned by a catalog.

JournalEntryScope

struct
Represents the lexical write scope for one state journal entry.

JournalId

struct
Identifies a journal independently of any grain activation.

JournalStreamWriter

struct
Writes journal entries for one state into the current journal batch.

LogDraftAbandonReason

enum
Identifies why a draft of an Orleans.Durable.Journaling.IDurableLog closed without entries.

LogDraftCommit

struct
Records that a draft of an Orleans.Durable.Journaling.IDurableLog committed the entries which begin at LogDraftCommit.

LogDraftId

struct
Identifies a draft of an Orleans.Durable.Journaling.IDurableLog.

LogEvent<T>

struct
Describes an entry or event read from an Orleans.Durable.Journaling.IDurableLog.

LogEventKind

enum
Identifies the kind of a Orleans.Durable.Journaling.LogEvent.

ValueChange<T>

struct
Describes the latest committed value of an Orleans.Durable.Journaling.IDurableValue.

Orleans.Durable.Journaling.Json

JsonLinesJournalFormat

class
Encodes journal entries as UTF-8 JSON Lines and replays complete records in order.

Orleans.Durable.Messaging

Accepted

class
The receiver durably accepted the message.

Backpressured

class
The inbox is at capacity; the sender retries later.

DeadLettered

class
The receiver rejected the message permanently.

DeadLettered

class
The outbox dead-lettered the message: its delivery attempts didn't succeed before its retry limits elapsed, or its source failed to provide it, or the receiver answered DeliveryResult. The receiver's earlier delivery outcome is unknown: an earlier attempt can have been durably accepted.

Delivered

class
The receiver durably accepted the message, or reported it as a duplicate.

DeliveryResult

struct
The receiver's answer to an attempt to deliver a message to its inbox.

Duplicate

class
The inbox already holds the message or retains its processed record.

Envelope

struct
Contains a command identity, payload, subject, optional application headers, and an optional delivery time.

Expired

class
The message was sent at or before the receiver's durable admission floor, and the receiver retains no outcome for it.

HierarchicalKey

struct
An immutable, ordinal application identity formed from nonempty hierarchical segments.

IInbox

interface
Registers handlers for the messages delivered to a grain's inbox.

IInboxHandlerContext

interface
Exposes the received message and its attempt-scoped terminal outcome.

IInboxMessageSink

interface
Accepts delivered messages directly into application-owned journaled state, so their payload is journaled once.

IMessagingExtension

interface
The grain extension through which other grains exchange durable messages with this grain.

InboxMessage

struct
A received command whose destination is the grain owning the inbox.

IOutbox

interface
Stages opaque durable messages alongside a grain's journaled business state.

IOutboxMessageSource

interface
Provides outgoing messages whose payload and receiver the application stores in its own journaled state.

MessageType<T>

class
Binds an exact message subject to an Orleans payload serializer.

OutboxExtensions

class
Extensions for encoding and staging typed messages and replies.

OutboxMessage

struct
An outgoing command with destination routing separate from its common envelope.

Rejected

class
The receiver durably rejected the message, with the reason and code which it reported.

Orleans.Durable.Messaging.Configuration

DurableMessagingOptions

class
Configuration options for durable messaging inboxes, outboxes, and the messaging pump.

Orleans.Durable.Messaging.Diagnostics

InboxMessageReceiving

class
Event payload for a new delivery whose send time is above the inbox's admission floor, before the inbox stages message effects.

MessagingEvent

class
The base class used for durable messaging diagnostic events.

MessagingEvents

class
Provides the diagnostic listener and event payload types for durable messaging events.

OutboxMessageRetired

class
Event payload for an outbox message whose retirement the outbox staged: the message was delivered, its receiver rejected it, or the outbox dead-lettered it.

OutboxRetryScheduled

class
Event payload for a failed delivery attempt whose retry the outbox staged.

Orleans.Durable.Tasks

DurableTaskAddress

struct
The address of a durable task which other parties reach: the grain which stores the task and the task's identifier on that grain.

DurableTaskConflictException

class
Represents a schedule of a request under a task identifier which the target grain already associates with a different operation, such as a different method or caller.

DurableTaskDeliveryException

class
Represents the start of a durable task whose invocation the starter's outbox dead-lettered without a confirmed outcome, so whether the task's grain ran the task is unknown.

DurableTaskReferenceAwaiter<TResult>

struct
Awaits a Orleans.Durable.Tasks.DurableTaskReference: as a subscribed child in a durable execution, and otherwise by waiting for the task's result.

DurableTaskRejectedException

class
Represents the start of a durable task whose grain permanently rejected the invocation for a reason other than a conflict, which it reports with a rejection code of its own, or without one.

DurableTaskRejectionCodes

class
The rejection codes with which a grain dead-letters a durable task invocation which it rejects permanently, and which the starter's record reports.

IDurableTaskManager

interface
Observes and controls the durable tasks of the current durable grain activation, without a grain call.

Orleans.Durable.Tasks.Diagnostics

DurableTaskEvent

class
The base class used for durable task runtime diagnostic events.

DurableTaskEvents

class
Provides the diagnostic listener and event payload types for the durable task runtime of grains.

ExecutionStalled

class
Event payload for an attempt which stalled because the running code can't replay its execution: the execution recorded a version which the code doesn't support, or the code diverged from the recorded execution. The runtime discarded the attempt's result and keeps the task pending, and a later activation replays it.

ExecutionStarted

class
Event payload for an attempt of a task's body which the runtime started on the activation.

ExecutionStopped

class
Event payload for an attempt of a task's body which ended on the activation: the body completed, or the runtime abandoned the attempt, for example because an abort or a deletion ended the task.

ReplayEnded

class
Event payload for an attempt of a task's body which replayed the operations which earlier attempts recorded, and started an operation which no earlier attempt recorded: DurableTaskContext.IsReplaying reports false from this point.

SelectionWaitStarted

class
Event payload for a selection of the first task to complete, such as DurableTask.WhenAny's, which found no completed candidate and waits for one.

SignalWaitEnded

class
Event payload for an execution's wait for a signal which ended: the signal's value committed, or the wait was canceled.

SignalWaitStarted

class
Event payload for an execution which started waiting for a signal which hasn't arrived.

TaskCompleted

class
Event payload for a task whose terminal result the runtime staged.

TaskCreated

class
Event payload for a task whose state the runtime staged: an invoked task, or an operation of an execution.

TaskDeleted

class
Event payload for a task whose deletion the runtime staged, with its execution tree or when its retention ended.

VersionRecorded

class
Event payload for a version decision which an execution recorded: the version of a change which the execution follows from then on, which DurableTask.GetVersion returns to it and to its steps.

Orleans.Durable.Tasks.Protocol

DurableTaskRequestContext

class
Supports all classes in the .NET class hierarchy and provides low-level services to derived classes. This is the ultimate base class of all .NET classes; it is the root of the type hierarchy.

DurableTaskRequestShared

class
Supports all classes in the .NET class hierarchy and provides low-level services to derived classes. This is the ultimate base class of all .NET classes; it is the root of the type hierarchy.

Orleans.Hosting

DurableTaskHostingExtensions

class
Supports all classes in the .NET class hierarchy and provides low-level services to derived classes. This is the ultimate base class of all .NET classes; it is the root of the type hierarchy.