DeactivationReason
struct Represents a reason for initiating grain deactivation.
Microsoft.Orleans.Core.Abstractions
10.0.0 · net10.0
Orleans
DeactivationReasonCode
enum An informational reason code for deactivation.
ErrorCode
enum The set of error codes used by the Orleans runtime libraries for logging errors.
Grain
class The abstract base class for all grain classes.
Grain<TGrainState>
class Base class for a Grain with declared persistent state.
GrainBaseExtensions
class Helper methods for
IGrainBase implementations. GrainCallFilterDelegate
delegate A delegate used to intercept invocation of a request.
GrainCancellationToken
class An analogue to
GrainCancellationToken which can be sent between grains. GrainCancellationTokenSource
class An analogue to
System.Threading.CancellationTokenSource which can be sent between grains. GrainContextComponentExtensions
class Extensions for
IGrainContext related to IGrainExtension. GrainExtensions
class Extension methods for grains.
GrainFactoryExtensions
class Provides extension methods for creating grain references.
GrainTypeAttribute
class Specifies the grain type of the grain class which it is attached to.
IConfigurationValidator
interface Describes a configuration validator which is called during client and silo initialization.
IGrain
interface Marker interface for grains
IGrainBase
interface Interface for grain implementations
IGrainCallContext
interface Represents a method invocation as well as the result of invocation.
IGrainFactory
interface Functionality for creating references to grains.
IGrainObserver
interface A marker interface for grain observers. Observers are used to receive notifications from grains; that is, they represent the subscriber side of a publisher/subscriber interface.
IGrainWithGuidCompoundKey
interface Marker interface for grains with compound keys.
IGrainWithGuidKey
interface Marker interface for grains with
System.Guid keys. IGrainWithIntegerCompoundKey
interface Marker interface for grains with compound keys.
IGrainWithIntegerKey
interface Marker interface for grains with
System.Int64 keys. IGrainWithStringKey
interface Marker interface for grains with
System.String keys. IIncomingGrainCallContext
interface Represents an incoming method invocation as well as the result of invocation.
IIncomingGrainCallFilter
interface Interface for incoming grain call filters.
ILifecycleObservable
interface Observable lifecycle. Each stage of the lifecycle is observable. All observers will be notified when the stage is reached when starting, and stopping. Stages are started in ascending order, and stopped in descending order.
ILifecycleObserver
interface Lifecycle observer used to handle start and stop notification.
ILifecycleParticipant<TLifecycleObservable>
interface Provides hook to take part in lifecycle. Also may act as a signal interface indicating that an object can take part in lifecycle.
ILifecycleSubject
interface Both a lifecycle observer and observable lifecycle.
ILocalActivationStatusChecker
interface Provides a way to check whether a grain is locally activated.
IncomingGrainCallFilterDelegate
delegate A delegate used to intercept an outgoing request.
IOutgoingGrainCallContext
interface Represents an outgoing method invocation as well as the result of invocation.
IOutgoingGrainCallFilter
interface Interface for outgoing grain call filters.
ISystemTarget
interface This is a markup interface for system targets. System target are internal runtime objects that share some behavior with grains, but also impose certain restrictions. In particular: System target are asynchronously addressable actors. Proxy class is being generated for ISystemTarget, just like for IGrain System target are scheduled by the runtime scheduler and follow turn based concurrency.
IVersionManager
interface Functionality for managing how grain interface versions are negotiated.
LifecycleExtensions
class Extensions for working with lifecycle observers.
OutgoingGrainCallFilterDelegate
delegate A delegate used to intercept an incoming request.
PublicOrleansTaskExtensions
class Utility functions for dealing with
System.Threading.Tasks.Task instances. StableHash
class Provides stable hash functions whose results are consistent across processes and cluster nodes.
Orleans.CodeGeneration
InvokeMethodOptions
enum Invoke options for an
InvokeMethodRequestVersionAttribute
class The VersionAttribute allows to specify the version number of the interface
Orleans.Concurrency
AlwaysInterleaveAttribute
class The AlwaysInterleaveAttribute attribute is used to mark methods that can interleave with any method, including write (non ReadOnly) requests.
Immutable<T>
struct Wrapper class for carrying immutable data.
ImmutableExtensions
class Utility class to add the .AsImmutable method to all objects.
MayInterleaveAttribute
class The MayInterleaveAttribute attribute is used to mark classes that want to control request interleaving via supplied method callback.
OneWayAttribute
class Indicates that a method on a grain interface is one-way and that no response message will be sent to the caller.
ReadOnlyAttribute
class The ReadOnly attribute is used to mark methods that do not modify the state of a grain.
Marking methods as ReadOnly allows the run-time system to perform a number of optimizations that may significantly improve the performance of your application.
ReentrantAttribute
class The Reentrant attribute is used to mark grain implementation classes that allow request interleaving within a task.
This is an advanced feature and should not be used unless the implications are fully understood. That said, allowing request interleaving allows the run-time system to perform a number of optimizations that may significantly improve the performance of your application.
StatelessWorkerAttribute
class The StatelessWorker attribute is used to mark grain class in which there is no expectation of preservation of grain state between requests and where multiple activations of the same grain are allowed to be created by the runtime.
UnorderedAttribute
class The Unordered attribute is used to mark grain interface in which the delivery order of messages is not significant.
Orleans.Core
IStorage
interface Provides method for operating on grain storage.
IStorage<TState>
interface Provides method for operating on grain state.
Orleans.Core.Internal
ICallChainReentrantGrainContext
interface Provides functionality for entering and exiting sections of code within a grain during which requests bearing the same
RequestContext are allowed to re-enter the grain. IGrainManagementExtension
interface Provides functionality for performing management operations on a grain activation.
Orleans.Diagnostics
ActivitySources
class Provides names for Orleans
System.Diagnostics.ActivitySource instances. Orleans.GrainDirectory
GrainDirectoryAttribute
class Specifies the name of the grain directory provider to use for the grain class which this attribute is applied to.
IGrainDirectory
interface Interface for grain directory implementations
Orleans.Metadata
AttributeGrainBindingsProvider
class Provides grain interface properties from attributes implementing
IGrainPropertiesProviderAttribute. AttributeGrainPropertiesProvider
class Provides grain interface properties from attributes implementing
IGrainPropertiesProviderAttribute. AttributeGrainTypeProvider
class Gets the corresponding
GrainType for a grain class from an System.Attribute implementing IGrainTypeProviderAttribute on that class. ClusterManifest
class Information about types which are available in the cluster.
DefaultGrainTypeAttribute
class Specifies the default grain type to use when constructing a grain reference for this interface without specifying a grain type.
GrainInterfaceProperties
class Information about a communication interface.
GrainManifest
class Information about available grains.
GrainProperties
class Information about a logical grain type
GrainType. IGrainBindingsProviderAttribute
interface Interface for
System.Attribute classes which provide information about a grain. IGrainInterfacePropertiesProvider
interface Provides grain properties.
IGrainInterfacePropertiesProviderAttribute
interface Interface for
System.Attribute classes which provide information about a grain interface. IGrainPropertiesProvider
interface Provides grain properties.
IGrainPropertiesProviderAttribute
interface Interface for
System.Attribute classes which provide information about a grain. IGrainTypeProvider
interface Associates a
GrainType with a grain class. IGrainTypeProviderAttribute
interface Functionality which can be implemented by a custom
System.Attribute which implements this specifies the GrainType of the type which it is attached to. MajorMinorVersion
struct Represents a version with two components, a major (most-significant) component, and a minor (least-significant) component.
WellKnownGrainInterfaceProperties
class Well-known grain interface property keys.
WellKnownGrainTypeProperties
class Well-known grain properties.
Orleans.Placement
ActivationCountBasedPlacementAttribute
class Marks a grain class as using the
ActivationCountBasedPlacement policy, which attempts to balance grain placement across servers based upon the relative number of recently active grains on each one. HashBasedPlacementAttribute
class Marks a grain class as using the
HashBasedPlacement policy. ImmovableAttribute
class Ensures that activations of this grain type will not be migrated automatically.
ImmovableKind
enum Emphasizes that immovability is restricted to certain components.
PlacementAttribute
class Base for all placement policy marker attributes.
PlacementFilterAttribute
class Base for all placement filter marker attributes.
PlacementFilterStrategy
class Represents a strategy for filtering silos which a grain can be placed on.
PreferLocalPlacementAttribute
class Marks a grain class as using the
PreferLocalPlacement policy. RandomPlacementAttribute
class Marks a grain class as using the
RandomPlacement policy. ResourceOptimizedPlacementAttribute
class Marks a grain class as using the
ResourceOptimizedPlacement policy. SiloRoleBasedPlacementAttribute
class Marks a grain class as using the
SiloRoleBasedPlacement policy. Orleans.Providers
IProviderBuilder<TBuilder>
interface Interface for providers which configure Orleans services.
LogConsistencyProviderAttribute
class The [Orleans.Providers.LogConsistencyProvider] attribute is used to define which consistency provider to use for grains using the log-view state abstraction.
Specifying [Orleans.Providers.LogConsistencyProvider] property is recommended for all grains that derive from LogConsistentGrain, such as JournaledGrain. If no [Orleans.Providers.LogConsistencyProvider] attribute is specified, then the runtime tries to locate one as follows. First, it looks for a "Default" provider in the configuration file, then it checks if the grain type defines a default. If a consistency provider cannot be located for this grain, then the grain will fail to load into the Silo.
ProviderConstants
class Constant values used by providers.
StorageProviderAttribute
class The [Orleans.Providers.StorageProvider] attribute is used to define which storage provider to use for persistence of grain state.
Specifying [Orleans.Providers.StorageProvider] property is recommended for all grains which extend Grain<T>. If no [Orleans.Providers.StorageProvider] attribute is specified, then a "Default" storage provider will be used. If a suitable storage provider cannot be located for this grain, then the grain will fail to load into the Silo.
Orleans.Runtime
ActivationCountBasedPlacement
class A placement strategy which attempts to achieve approximately even load based upon the number of recently-active grains on each server.
ActivationId
struct Uniquely identifies a grain activation.
ActivationIdConverter
class Functionality for converting
ActivationId instances to and from their JSON representation. AsyncEnumerableExtensions
class Provides extension methods for configuring asynchronous enumerable grain requests.
AsyncEnumerableRequest<T>
class Represents a request to an
System.Collections.Generic.IAsyncEnumerable-returning method. AttributeGrainInterfaceTypeProvider
class Gets a
GrainInterfaceType from attributes implementing IGrainInterfaceTypeProviderAttribute. Category
enum Type id values encoded into UniqueKeys
ClientNotAvailableException
class Indicates that a client is not longer reachable.
EnumerationAbortedException
class Indicates that an enumeration was aborted.
EnumerationResult
enum Identifies enumeration results.
GatewayTooBusyException
class Signifies that a gateway silo is currently in overloaded / load shedding state and is unable to currently accept this message being sent.
GrainAddress
class Represents an entry in a
IGrainDirectoryGrainAddressCacheUpdate
class Represents a directive to update an invalid, cached
GrainAddress to a valid GrainAddress. GrainContextExtensions
class Extensions for
IGrainContext. GrainExtensionNotInstalledException
class Signifies that an attempt was made to invoke a grain extension method on a grain where that extension was not installed.
GrainId
struct Identifies a grain.
GrainIdJsonConverter
class Functionality for converting a
GrainId to and from a JSON string. GrainIdKeyExtensions
class Extensions for
GrainId keys. GrainInterfaceType
struct Uniquely identifies a grain interface.
GrainInterfaceTypeAttribute
class When applied to a grain interface, specifies the
GrainInterfaceType. GrainLifecycleStage
class Stages of a grains lifecycle. TODO: Add more later, see ActivationInitializationStage Full grain lifecycle, including register, state setup, and stream cleanup should all eventually be triggered by the grain lifecycle.
GrainReference
class This is the base class for all grain references.
GrainReferenceNotBoundException
class Indicates that a
GrainReference was not bound to the runtime before being used. GrainReferenceShared
class Properties common to
GrainReference instances with the same GrainReferenceShared and GrainInterfaceType. GrainTimerCreationOptions
struct Options for creating grain timers.
GrainType
struct Represents the type of a grain.
GrainTypePrefix
class Prefixes and corresponding helper methods for
GrainType. GuidId
class A unique identifier based on a
GuidId. GuidIdConverter
class Functionality for converting
GuidId instances to and from their JSON representation. HashBasedPlacement
class Places activations on compatible silos by hashing the grain identifier using a stable hash and selecting a silo from a sorted set using a modulo operation.
IAddressable
interface Marker interface for addressable endpoints, such as grains, observers, and other system-internal addressable endpoints
IAsyncEnumerableGrainExtension
interface Grain extension interface for grains which return
System.Collections.Generic.IAsyncEnumerable from grain methods. IAsyncEnumerableRequest<T>
interface Interface for requests to a
System.Collections.Generic.IAsyncEnumerable-returning methods. IDehydrationContext
interface Records the state of a grain activation which is in the process of being dehydrated for migration to another location.
IdSpan
struct Primitive type for identities, representing a sequence of bytes.
IdSpanCodec
class Functionality for serializing and deserializing
IdSpan instances. IGrainContext
interface Represents a grain from the perspective of the runtime.
IGrainContextAccessor
interface Provides access to the currently executing grain context.
IGrainExtension
interface Marker interface for grain extensions, used by internal runtime extension endpoints.
IGrainExtensionBinder
interface Functionality for accessing or installing an extension on a grain.
IGrainInterfaceTypeProvider
interface Gets a
GrainInterfaceType for an interface. IGrainInterfaceTypeProviderAttribute
interface An
System.Attribute which implements this specifies the GrainInterfaceType of the type which it is attached to. IGrainLifecycle
interface The observable grain lifecycle.
IGrainMigrationParticipant
interface Participates in the dehydration and rehydration of a grain activation during migration.
IGrainReferenceRuntime
interface Runtime logic for
GrainReferences to be usable. This service is not meant to be used directly by user code. IGrainRuntime
interfaceIGrainTimer
interface Represents a timer belonging to a grain.
ILocalRequest
interface A request which a grain context receives through
IGrainContext and which receives its own response. IRehydrationContext
interface Contains the state of a grain activation which is in the process of being rehydrated after moving from another location.
IRequest
interface Represents a request to invoke a method on a grain.
IWorkItemScheduler
interface Functionality to schedule tasks on a grain.
LegacyGrainId
class Represents an identifier using the legacy Orleans grain identity encoding.
LimitExceededException
class Signifies that a grain is in an overloaded state where some runtime limit setting is currently being exceeded, and so that grain is unable to currently accept the message being sent.
LocalRequestOptions
struct Options for a request which a grain queues on its own activation, using
IGrainContext or GrainBaseExtensions's RunRequestAsync methods. LogFormatter
class Formats values for logging purposes.
MembershipVersion
struct Identifies the version of a cluster membership configuration.
MembershipVersionConverter
class Functionality for converting
MembershipVersion instances to and from JSON. OrleansConfigurationException
class Represents a configuration exception.
OrleansException
class An exception class used by the Orleans runtime for reporting errors.
OrleansLifecycleCanceledException
class Indicates a lifecycle was canceled, either by request or due to observer error.
OrleansMessageRejectionException
class Indicates that an Orleans message was rejected.
PlacementStrategy
class The base type for all placement strategies.
PreferLocalPlacement
class The prefer local placement strategy indicates that a grain should always be placed on the local host if the grain is not already active elsewhere in the cluster and the local host is compatible with it.
RandomPlacement
class The random placement strategy specifies that new activations of a grain should be placed on a random, compatible server.
ReentrancySection
struct Represents a scoped change to call-chain reentrancy.
Request
class Base class for requests for methods which return
System.Threading.Tasks.ValueTask. Request<TResult>
class Base class for requests for methods which return
System.Threading.Tasks.ValueTask. RequestBase
class Base type used for method requests.
RequestContext
class This class holds information regarding the request currently being processed. It is explicitly intended to be available to application code.
ResourceOptimizedPlacement
class A placement strategy which attempts to optimize resource distribution across the cluster.
SiloAddress
class Data class encapsulating the details of silo addresses.
SiloAddressConverter
class Functionality for converting
SiloAddress instances to and from their JSON representation. SiloRoleBasedPlacement
class The silo role placement strategy specifies that a grain should be placed on a compatible silo which has the role specified by the strategy's placement attribute.
SiloUnavailableException
class Signifies that an request was canceled due to target silo unavailability.
SystemTargetGrainId
struct Identifies a system target.
SystemTargetPlacementStrategy
class The placement strategy used by system targets.
TaskRequest
class Base class for requests for methods which return
System.Threading.Tasks.ValueTask. TaskRequest<TResult>
class Base class for requests for methods which return
System.Threading.Tasks.Task. UniqueKey
class Represents the composite key used by the legacy Orleans grain identifier encoding.
UniqueKeyJsonConverter
class Functionality for converting
UniqueKey instances to and from their JSON representation. Utils
class The Utils class contains a variety of utility methods for use in application and grain code.
VoidRequest
class Base class for requests for void-returning methods.
WrappedException
class An exception class used by the Orleans runtime for reporting errors.
Orleans.Runtime.Serialization
SiloAddressCodec
class Serializer and deserializer for
SiloAddress instances. Orleans.Serialization
DeserializationContext
class Provides services and runtime state associated with a deserialization operation.
IOnDeserialized
interface Indicates that a class is to be notified when it has been deserialized.
Orleans.Services
IGrainService
interface Base interface for grain services.
IGrainServiceClient<TGrainService>
interface Base interface for grain service clients.
Orleans.Statistics
EnvironmentStatistics
struct Contains statistics about the current process and its execution environment.
IAppEnvironmentStatistics
interface Provides functionality for accessing statistics relating to the application environment.
IEnvironmentStatisticsProvider
interface Provides statistics about the current process and its execution environment.
IHostEnvironmentStatistics
interface Functionality for accessing statistics relating to the hosting environment.
Orleans.Timers
ITimerRegistry
interface Functionality for managing grain timers.
Orleans.Versions
IVersionStore
interface Functionality for accessing runtime-modifiable grain interface version strategies.
Orleans.Versions.Compatibility
AllVersionsCompatible
class A grain interface version compatibility strategy which treats all versions of an interface compatible with any requested version.
BackwardCompatible
class A grain interface version compatibility strategy which treats all versions of an interface compatible only with equal and lower requested versions.
CompatibilityStrategy
class Base class for all grain interface version compatibility strategies.
ICompatibilityDirector
interface Functionality for grain interface compatibility directors.
StrictVersionCompatible
class A grain interface version compatibility strategy which treats all versions of an interface compatible only with equal requested versions.
Orleans.Versions.Selector
AllCompatibleVersions
class Grain interface version selector which allows any compatible version to be chosen.
IVersionSelector
interface Functionality for selecting which versions of a grain interface should be preferred when performing grain placement.
LatestVersion
class Grain interface version selector which always selects the highest compatible version.
MinimumVersion
class Grain interface version selector which always selects the lowest compatible version.
VersionSelectorStrategy
class Base class for all grain interface version selector strategies.