Redigera

Dela via


Orleans Namespace

Classes

AliasAttribute

When applied to a type or method, specifies a well-known name which can be used to identify that type or method.

ApplicationPartAttribute

Specifies an assembly to be added as an application part.

ApplicationPartManagerExtensions

Extensions for working with ApplicationPartManager.

AsyncSerialExecutor

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>

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

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.

BatchWorkerFromDelegate

A BatchWorker implementation which executes a provided delegate as its Work() implementation.

ClientBuilder

Builder used for creating IClusterClient instances.

ClientBuilderExtensions

Extension methods for IClientBuilder.

ClientBuilderGrainCallFilterExtensions

Extensions for configuring grain call filters.

ClientStreamingExtensions

Extension methods for accessing stream providers from a client.

CollectionAgeLimitAttribute

Specifies the period of inactivity before a grain is available for collection and deactivation.

CompoundTypeAliasAttribute

When applied to a type, indicates that the type should be encoded as a relation from a specified type.

DefaultInvokableBaseTypeAttribute

Applied to proxy base types and to attribute types used on invokable interface methods to specify the base type for the invokable object which represents a method call.

DefaultInvokeMethodNameAttribute

Applied to proxy base types and to attribute types used on invokable interface methods to specify the base type for the invokable object which represents a method call.

GatewayCountChangedEventArgs

Event arguments for gateway connectivity events.

GenerateCodeForDeclaringAssemblyAttribute

Indicates that the source generator should also inspect and generate code for the assembly containing the specified type.

GeneratedActivatorConstructorAttribute

When applied to a constructor, indicates that generated activator implementations should use that constructor when activating instances.

GenerateMethodSerializersAttribute

When applied to an interface, specifies that support code should be generated to allow remoting of interface calls.

GenerateSerializerAttribute

When applied to a type, specifies that the type is intended to be serialized and that serialization code should be generated for the type.

GetCompletionSourceMethodNameAttribute

Applied to method attributes on invokable interfaces to specify the name of the method to call to get a completion source which is submitted to the submit method and eventually returned to the caller.

Grain

The abstract base class for all grain classes.

Grain<TGrainState>

Base class for a Grain with declared persistent state.

GrainBaseExtensions

Helper methods for IGrainBase implementations.

GrainCancellationToken

An analogue to CancellationToken which can be sent between grains.

GrainCancellationTokenSource

An analogue to CancellationTokenSource which can be sent between grains.

GrainClient

Client runtime for connecting to Orleans system

GrainContextComponentExtensions

Extensions for IGrainContext related to IGrainExtension.

GrainExtensions

Extension methods for grains.

GrainInterfaceTypeToGrainTypeResolver

Associates GrainInterfaceTypes with a compatible GrainType.

GrainReminderExtensions

Extension methods for accessing reminders from a Grain or IGrainBase implementation.

GrainState

Base class for generated grain state classes.

GrainState<T>

Default implementation of IGrainState<T>.

GrainStreamingExtensions

Extension methods for accessing stream providers from a Grain or IGrainBase implementation.

GrainTypeAttribute

Specifies the grain type of the grain class which it is attached to.

IdAttribute

Specifies the unique identity of a member.

ImmutableAttribute

Indicates that the type, type member, parameter, or return value which it is applied to should be treated as immutable and therefore that defensive copies are never required. When applied to non-sealed classes, derived types are not guaranteed to be immutable.

ImplicitChannelSubscriptionAttribute

The [Orleans.ImplicitStreamSubscription] attribute is used to mark grains as implicit stream subscriptions.

ImplicitStreamSubscriptionAttribute

The [Orleans.ImplicitStreamSubscription] attribute is used to mark grains as implicit stream subscriptions.

InvokableBaseTypeAttribute

Applied to attribute types used on invokable interface methods to specify the base type for the invokable object which represents a method call.

InvokableCustomInitializerAttribute

Applied to interface method attribute types to specify a method to be called on invokable objects which are created when invoking that interface method.

InvokeMethodNameAttribute

Applied to method attributes on invokable interfaces to specify the name of the method on the base type to call when submitting a request.

JenkinsHash
KeepAliveAttribute

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

LifecycleExtensions

Extensions for working with lifecycle observers.

LifecycleSubject

Provides functionality for observing a lifecycle.

MembershipEntry
MembershipTableData
NamedOptionExtensions

Extensions for working with named option classes.

ObserverSubscriptionManager<T>

The ObserverSubscriptionManager class is a helper class for grains that support observers. It provides methods for tracking subscribing observers and for sending notifications.

OmitDefaultMemberValuesAttribute

When applied to a type, indicates that generated serializers for the type should avoid serializing members if the member value is equal to its default value.

OptionFormattingUtilities

Utility class for option formatting

OptionsLogger

Base class for client and silo default options loggers.

OrleansConnectionSecurityHostingExtensions
OrleansConstructorAttribute

Specifies the constructor the serializer should use when creating new instances from serialized data.

PeriodicAction
PersistentStateAttributeMapper

Attribute mapper which maps persistent state attributes to a corresponding factory instance.

PublicOrleansTaskExtensions

Utility functions for dealing with Task instances.

RedactAttribute

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

RedactConnectionStringAttribute

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

RegexImplicitChannelSubscriptionAttribute

The [Orleans.RegexImplicitStreamSubscription] attribute is used to mark grains as implicit stream subscriptions by filtering stream namespaces to subscribe using a regular expression.

RegexImplicitStreamSubscriptionAttribute

The [Orleans.RegexImplicitStreamSubscription] attribute is used to mark grains as implicit stream subscriptions by filtering stream namespaces to subscribe using a regular expression.

RegisterActivatorAttribute

When applied to a type, indicates that the type is an activator and that it should be automatically registered.

RegisterConverterAttribute

When applied to a type, indicates that the type is a converter and that it should be automatically registered.

RegisterCopierAttribute

When applied to a type, indicates that the type is an copier and that it should be automatically registered.

RegisterProviderAttribute

When applied to a type, indicates that the type is a provider and that it should be automatically registered.

RegisterSerializerAttribute

When applied to a type, indicates that the type is a serializer and that it should be automatically registered.

ReminderEntry

Represents a reminder table entry.

ReminderTableData

Represents a collection of reminder table entries.

ResponseTimeoutAttribute

Specifies the response timeout for the interface method which it is specified on.

SerializationCallbacksAttribute

Specifies a type to be instantiated and invoked when performing serialization operations on instances of the type which this attribute is attached to.

SerializerConfigurationValidator

Validates serializer configuration.

SerializerTransparentAttribute

Indicates that the specific type is invisible for serialization purposes. Usable only on abstract types with no serialized fields and effectively removes it from the inheritance hierarchy. Adding/removing this attribute from a type will cause serialization protocol level incompatibility (like type hierarchy changes).

ServiceLifecycleStage

Lifecycle stages of an Orleans client or silo.

StableHash
SuppressReferenceTrackingAttribute

When applied to a type, indicates that generated serializers for the type should not track references to the type.

TableVersion
TaskDone

A special void 'Done' Task that is already in the RunToCompletion state. Equivalent to Task.FromResult(1).

TlsConnectionBuilderExtensions
TransactionAttribute

The TransactionAttribute attribute is used to mark methods that start and join transactions.

TransactionRequest
TransactionRequest<TResult>
TransactionRequestBase
TransactionResponse
TransactionTaskRequest
TransactionTaskRequest<TResult>
UseActivatorAttribute

When applied to a type, indicates that the type should be activated using a registered activator rather than via its constructor or another mechanism.

Structs

DeactivationReason

Represents a reason for initiating grain deactivation.

Interfaces

IClientBuilder

Functionality for building IClusterClient instances.

IClientConnectionRetryFilter

Filter used to determine if cluster connection should be retried.

IClusterClient

Client interface for interacting with an Orleans cluster.

IClusterClientLifecycle

A ILifecycleObservable marker type for client lifecycles.

IConfigurationValidator

Describes a configuration validator which is called during client and silo initialization.

IConverter<TValue,TSurrogate>

Functionality for converting between two types.

IFacetMetadata

Marker interface for facets

IGrain

Marker interface for grains

IGrainBase

Interface for grain implementations

IGrainCallContext

Represents a method invocation as well as the result of invocation.

IGrainCallFilter

Interface for grain call filters.

IGrainFactory

Functionality for creating references to grains.

IGrainInvokeInterceptor
IGrainObserver

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.

IGrainState

Defines the state of a grain

IGrainState<T>

Defines the state of a grain

IGrainWithGuidCompoundKey

Marker interface for grains with compound keys.

IGrainWithGuidKey

Marker interface for grains with Guid keys.

IGrainWithIntegerCompoundKey

Marker interface for grains with compound keys.

IGrainWithIntegerKey

Marker interface for grains with Int64 keys.

IGrainWithStringKey

Marker interface for grains with String keys.

IIncomingGrainCallContext

Represents an incoming method invocation as well as the result of invocation.

IIncomingGrainCallFilter

Interface for incoming grain call filters.

ILifecycleObservable

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

Lifecycle observer used to handle start and stop notification.

ILifecycleParticipant<TLifecycleObservable>

Provides hook to take part in lifecycle. Also may act as a signal interface indicating that an object can take part in lifecycle.

ILifecycleSubject

Both a lifecycle observer and observable lifecycle.

IMembershipTable

Interface for Membership Table.

IMembershipTableGrain

Membership table interface for grain based implementation.

IMembershipTableSystemTarget

Membership table interface for system target based implementation.

IOptionFormatter

format the option and give it a category and a name

IOptionFormatter<T>

Option formatter for a certain option type T

IOptionFormatterResolver<T>

IOptionFormatterResolver resolve specific OptionFormatter for certain named option

IOutgoingGrainCallContext

Represents an outgoing method invocation as well as the result of invocation.

IOutgoingGrainCallFilter

Interface for outgoing grain call filters.

IPopulator<TValue,TSurrogate>

Functionality for populating one type from another.

IRemindable

Callback interface that grains must implement in order to be able to register and receive Reminders.

IReminderService

Functionality for managing reminders.

IReminderTable

Interface for implementations of the underlying storage for reminder data: Azure Table, SQL, development emulator grain, and a mock implementation. Defined as a grain interface for the development emulator grain case.

ISystemTarget

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.

ITransactionClient
IVersionManager

Functionality for managing how grain interface versions are negotiated.

Enums

DeactivationReasonCode

An informational reason code for deactivation.

ErrorCode

The set of error codes used by the Orleans runtime libraries for logging errors.

GenerateFieldIds

This enum provides options for controlling the field id generation logic.

TransactionOption
TransactionOptionAlias

Delegates

ClientInvokeCallback

The delegate called before every request to a grain.

ConnectionToClusterLostHandler

Handler for client disconnection from a cluster.

Factory<TInstance>

Creates an instance of TInstance.

Factory<TParam1,TInstance>

Creates an instance of TInstance.

Factory<TParam1,TParam2,TInstance>

Creates an instance of TInstance.

Factory<TParam1,TParam2,TParam3,TInstance>

Creates an instance of TInstance.

GatewayCountChangedHandler

Handler for the number of gateways.

GrainCallFilterDelegate

A delegate used to intercept invocation of a request.

IncomingGrainCallFilterDelegate

A delegate used to intercept an outgoing request.

OutgoingGrainCallFilterDelegate

A delegate used to intercept an incoming request.