Skip to content

Microsoft.Orleans.Core

10.0.0 · net10.0

Microsoft.Extensions.Hosting

Orleans

AsyncSerialExecutor

class
A utility class that provides serial execution of async functions. In can be used inside reentrant grain code to execute some methods in a non-reentrant (serial) way.

AsyncSerialExecutor<TResult>

class
A utility class that provides serial execution of async functions. In can be used inside reentrant grain code to execute some methods in a non-reentrant (serial) way.

BatchWorker

class
General pattern for an asynchronous worker that performs a work task, when notified, to service queued work. Each work cycle handles ALL the queued work. If new work arrives during a work cycle, another cycle is scheduled. The worker never executes more than one instance of the work cycle at a time, and consumes no resources when idle. It uses TaskScheduler.Current to schedule the work cycles.

GrainState<T>

class
Default implementation of Orleans.IGrainState.

IClusterClient

interface
Client interface for interacting with an Orleans cluster.

IServiceLifecycle

interface
Allows consumers to observe and participate in the client/silo's lifecycle.

KeepAliveAttribute

class
When applied to a grain implementation type this attribute specifies that activations of the grain shouldn't be collected by the idle activation collector.

MembershipTableData

class
Represents an atomic snapshot of membership entries and the membership table version.

OptionsLogger

class
Base class for client and silo default options loggers.

RedactAttribute

class
When applied to a property on an options class, this attribute prevents the property value from being formatted by conforming IOptionFormatter instances.

TableVersion

class
Represents the version of a membership table and the entity tag used for optimistic concurrency.

Orleans.Configuration

GatewayOptions

class
Options for configuring how clients interact with gateway endpoints.

GrainVersioningOptions

class
Versioning options govern grain implementation selection in heterogeneous deployments.

MessagingOptions

class
Specifies global messaging options that are common to client and silo.

OptionConfigureExtensionMethods

class
Extension methods on Microsoft.Extensions.DependencyInjection.IServiceCollection, to provider better usability to IOptionFormatter.

Orleans.Configuration.Internal

Orleans.Configuration.Overrides

OptionsOverrides

class
Functionality for overriding options using named options, falling back to the default (unnamed) value.

Orleans.Connections.Transport

ConnectionAbortedException

class
Indicates that a transport connection was terminated before initialization or a pending operation could complete.

ConnectionResetException

class
Indicates that a transport connection was terminated by a reset from the remote peer or the underlying network.

MessageTransport

class
Represents a bi-directional communication channel between two hosts.

Orleans.Connections.Transport.Security

CertificateLoader

class
Provides methods for loading TLS certificates from an operating system certificate store.

RemoteCertificateValidator

delegate
Represents a multicast delegate; that is, a delegate that can have more than one element in its invocation list.

TlsOptions

class
Settings for how TLS connections are handled.

Orleans.Core.Diagnostics

ClientLifecycleEvents

class
Provides the diagnostic listener and event payload types for Orleans client lifecycle events.

LifecycleEvent

class
The base class used for lifecycle diagnostic events.

ObserverCompleted

class
Event payload for when a lifecycle observer has completed successfully.

ObserverFailed

class
Event payload for when a lifecycle observer has failed.

ObserverStarting

class
Event payload for when a lifecycle observer is about to start.

ObserverStopped

class
Event payload for when a lifecycle observer has stopped.

ObserverStopping

class
Event payload for when a lifecycle observer is about to stop.

StageCompleted

class
Event payload for when a lifecycle stage has completed successfully.

StageFailed

class
Event payload for when a lifecycle stage has failed.

StageStarting

class
Event payload for when a lifecycle stage is about to start.

StageStopped

class
Event payload for when a lifecycle stage has stopped.

StageStopping

class
Event payload for when a lifecycle stage is about to stop.

Orleans.GrainDirectory

IGrainLocator

interface
Used to locate Grain activation in the cluster

UnregistrationCause

enum
Indicates the reason for removing activations from the directory. This influences the conditions that are applied when determining whether or not to remove an entry.

Orleans.GrainReferences

Orleans.Hosting

NamedServiceConfigurator

class
Component configurator base class for names services This associates any configurations or subcomponents with the same name as the service being configured

Orleans.Internal

AsyncExecutorWithRetries

class
This class is a convenient utility class to execute a certain asynchronous function with retries, allowing to specify custom retry filters and policies.

FixedBackoff

class
A fixed-duration backoff implementation, which always returns the configured delay.

IBackoffProvider

interface
Functionality for determining how long to wait between successive operation attempts.

Orleans.LeaseProviders

AcquireLeaseResult

class
AcquireLeaseResult class, which demonstrates result of acquiring or renewing lease operation

LeaseRequest

class
Lease request where you can specify ResourceKey and duration of your lease.

ResponseCode

enum
Identifies the result of a lease acquisition or renewal operation.

Orleans.Messaging

Orleans.Metadata

GrainBindings

class
Describes the bindings for a given grain type.

Orleans.Placement

Orleans.Placement.Rebalancing

RebalancerStatus

enum
The status of the Orleans.Placement.Rebalancing.IActivationRebalancerWorker.

Orleans.Placement.Repartitioning

CandidateConnectedVertex

struct
Represents a vertex connected to an activation migration candidate and its contribution to the transfer score.

EdgeVertex

struct
Data structure representing one side of a Orleans.Placement.Repartitioning.Edge.

IImbalanceToleranceRule

interface
Represents a rule that controls the degree of imbalance between the number of grain activations (that is considered tolerable), when any pair of silos are exchanging activations.

Orleans.Providers

IControllable

interface
A general interface for controllable components inside Orleans runtime.

IProviderRuntime

interface
Interface to allow callbacks from providers into their assigned provider-manager. This allows access to runtime functionality, such as logging.

Orleans.Runtime

ActivityNames

class
Defines names for activities emitted by the Orleans runtime.

GrainCallFrequency

struct
Represents an estimation of the frequency calls made from a source grain to a target grain.

IHealthCheckable

interface
Interface for services which can be probed for health status.

IManagementGrain

interface
Interface for system management functions of silos, exposed as a grain for receiving remote requests / commands.

IRingRange

interface
Represents a range or set of ranges around a virtual ring where points along the ring are identified using System.UInt32 values.

ISingleRange

interface
Represents a single, contiguous range round a virtual ring where points along the ring are identified using System.UInt32 values.

SimpleGrainStatistic

class
Simple snapshot of current statistics for a given grain type on a given silo.

TimeProviderNames

class
Service keys used to resolve per-area System.TimeProvider instances from dependency injection for the areas owned by the Orleans core runtime. Individual extension packages (reminders, streaming, transactions, durable jobs, journaling, and similar) define their own keys in the corresponding package.

Orleans.Runtime.Configuration

Orleans.Runtime.Internal

Orleans.Runtime.Messaging

Orleans.Runtime.Placement

PlacementTarget

struct
Describes a placement target, which is a grain as well as context regarding the request which is triggering grain placement.

Orleans.Serialization

IPAddressConverter

class
Newtonsoft.Json.JsonConverter implementation for System.Net.IPAddress.

IPAddressJsonConverter

class
Functionality for converting System.Net.IPAddress instances to and from their JSON representation.

IPEndPointConverter

class
Newtonsoft.Json.JsonConverter implementation for System.Net.IPEndPoint.

IPEndPointJsonConverter

class
Functionality for converting System.Net.IPEndPoint instances to and from their JSON representation.

OrleansJsonSerializationBinder

class
Implementation of Newtonsoft.Json.Serialization.ISerializationBinder which resolves types using a TypeConverter and enforces the configured Orleans type allow-list, preventing arbitrary types from being constructed during deserialization.

OrleansJsonSerializer

class
Serializes and deserializes values using Newtonsoft.Json settings configured for Orleans types.

OrleansJsonSerializerSettings

class
Provides factory and configuration methods for Newtonsoft.Json settings which support Orleans framework types.

Orleans.Storage

BadProviderConfigException

class
Exception thrown whenever a grain call is attempted with a bad / missing storage provider configuration settings for that grain.

IGrainStorage

interface
Interface to be implemented for a storage able to read and write Orleans grain state data.

IMemoryStorageGrain

interface
Grain interface for internal memory storage grain used by Orleans in-memory storage provider.

InconsistentStateException

class
Exception thrown when a storage detects an Etag inconsistency when attempting to perform a WriteStateAsync operation.

IRestExceptionDecoder

interface
Interface to be optionally implemented by storage to return richer exception details. TODO: Remove this interface. Move to decorator pattern for monitoring purposes. - jbragg

Orleans.Timers.Internal

ITimerManager

interface
Provides functionality for managing single-shot timers.

Orleans.Utilities