Grain<TGrainState> Class

Definition

Namespace:

Orleans

Assembly:

Orleans.Core.Abstractions.dll

Package:

Microsoft.Orleans.Core.Abstractions v8.2.0

Base class for a Grain with declared persistent state.

public class Grain<TGrainState> : Orleans.Grain

type Grain<'GrainState> = class
    inherit Grain

Public Class Grain(Of TGrainState)
Inherits Grain

Type Parameters

TGrainState

The class of the persistent state object

Inheritance

Object

Grain

Grain<TGrainState>

Constructors

Grain<TGrainState>()	Initializes a new instance of the Grain<TGrainState> class.
Grain<TGrainState>(IStorage<TGrainState>)	Initializes a new instance of the Grain<TGrainState> class.

Properties

GrainContext	(Inherited from Grain)
GrainFactory	Gets an object which can be used to access other grains. Null if this grain is not associated with a Runtime, such as when created directly for unit testing. (Inherited from Grain)
GrainReference	(Inherited from Grain)
IdentityString	String representation of grain's SiloIdentity including type and primary key. (Inherited from Grain)
RuntimeIdentity	A unique identifier for the current silo. There is no semantic content to this string, but it may be useful for logging. (Inherited from Grain)
ServiceProvider	Gets the IServiceProvider managed by the runtime. Null if this grain is not associated with a Runtime, such as when created directly for unit testing. (Inherited from Grain)
State	Gets or sets the grain state.

Methods

ClearStateAsync()	Clears the current grain state data from backing store.
DeactivateOnIdle()	Deactivate this activation of the grain after the current grain method call is completed. This call will mark this activation of the current grain to be deactivated and removed at the end of the current method. The next call to this grain will result in a different activation to be used, which typical means a new activation will be created automatically by the runtime. (Inherited from Grain)
DelayDeactivation(TimeSpan)	Delay Deactivation of this activation at least for the specified time duration. A positive timeSpan value means “prevent GC of this activation for that time span”. A negative timeSpan value means “cancel the previous setting of the DelayDeactivation call and make this activation behave based on the regular Activation Garbage Collection settings”. DeactivateOnIdle method would undo / override any current “keep alive” setting, making this grain immediately available for deactivation. (Inherited from Grain)
GetLogger()	Returns a logger object that this grain's code can use for tracing. The name of the logger will be derived from the grain class name. (Inherited from Grain)
GetLogger(String)	Returns a logger object that this grain's code can use for tracing. (Inherited from Grain)
GetReminder(String)	Returns a previously registered reminder. (Inherited from Grain)
GetReminders()	Returns a list of all reminders registered by the grain. (Inherited from Grain)
GetStreamProvider(String)	(Inherited from Grain)
GetStreamProviders()	(Inherited from Grain)
MigrateOnIdle()	Starts an attempt to migrating this instance to another location. Migration captures the current RequestContext, making it available to the activation's placement director so that it can consider it when selecting a new location. Migration will occur asynchronously, when no requests are executing, and will not occur if the activation's placement director does not select an alternative location. (Inherited from Grain)
OnActivateAsync()	This method is called at the end of the process of activating a grain. It is called before any messages have been dispatched to the grain. For grains with declared persistent state, this method is called after the State property has been populated. (Inherited from Grain)
OnActivateAsync(CancellationToken)	This method is called at the end of the process of activating a grain. It is called before any messages have been dispatched to the grain. For grains with declared persistent state, this method is called after the State property has been populated. (Inherited from Grain)
OnDeactivateAsync()	This method is called at the begining of the process of deactivating a grain. (Inherited from Grain)
OnDeactivateAsync(DeactivationReason, CancellationToken)	This method is called at the beginning of the process of deactivating a grain. (Inherited from Grain)
Participate(IGrainLifecycle)	(Inherited from Grain)
ReadStateAsync()	Reads grain state from backing store, updating State.
RegisterOrUpdateReminder(String, TimeSpan, TimeSpan)	Registers a persistent, reliable reminder to send regular notifications (reminders) to the grain. The grain must implement the Orleans.IRemindable interface, and reminders for this grain will be sent to the ReceiveReminder callback method. If the current grain is deactivated when the timer fires, a new activation of this grain will be created to receive this reminder. If an existing reminder with the same name already exists, that reminder will be overwritten with this new reminder. Reminders will always be received by one activation of this grain, even if multiple activations exist for this grain. (Inherited from Grain)
RegisterTimer(Func<Object,Task>, Object, TimeSpan, TimeSpan)	Obsolete. Registers a timer to send periodic callbacks to this grain. (Inherited from Grain)
UnregisterReminder(IGrainReminder)	Unregisters a previously registered reminder. (Inherited from Grain)
WriteStateAsync()	Write the current grain state data into the backing store.

Extension Methods

DeactivateOnIdle(IGrainBase)	Deactivate this grain activation after the current grain method call is completed. This call will mark this activation of the current grain to be deactivated and removed at the end of the current method. The next call to this grain will result in a different activation to be used, which typical means a new activation will be created automatically by the runtime.
MigrateOnIdle(IGrainBase)	Starts an attempt to migrating this instance to another location. Migration captures the current RequestContext, making it available to the activation's placement director so that it can consider it when selecting a new location. Migration will occur asynchronously, when no requests are executing, and will not occur if the activation's placement director does not select an alternative location.
RegisterGrainTimer(IGrainBase, Func<CancellationToken,Task>, GrainTimerCreationOptions)	Creates a grain timer.
RegisterGrainTimer(IGrainBase, Func<CancellationToken,Task>, TimeSpan, TimeSpan)	Creates a grain timer.
RegisterGrainTimer(IGrainBase, Func<Task>, GrainTimerCreationOptions)
RegisterGrainTimer(IGrainBase, Func<Task>, TimeSpan, TimeSpan)	Creates a grain timer.
RegisterGrainTimer<TState>(IGrainBase, Func<TState,CancellationToken,Task>, TState, GrainTimerCreationOptions)	Creates a grain timer.
RegisterGrainTimer<TState>(IGrainBase, Func<TState,CancellationToken,Task>, TState, TimeSpan, TimeSpan)	Creates a grain timer.
RegisterGrainTimer<TState>(IGrainBase, Func<TState,Task>, TState, GrainTimerCreationOptions)
RegisterGrainTimer<TState>(IGrainBase, Func<TState,Task>, TState, TimeSpan, TimeSpan)	Creates a grain timer.
AsReference(IAddressable, Type)	Returns a typed reference to the provided grain.
AsReference<TGrainInterface>(IAddressable)	Returns a typed reference to the provided grain.
Cast(IAddressable, Type)	Returns a typed reference to the provided grain.
Cast<TGrainInterface>(IAddressable)	Returns a typed reference to the provided grain.
GetGrainId(IAddressable)	Returns the grain id corresponding to the provided grain.
GetPrimaryKey(IAddressable)	Returns the Guid representation of a grain primary key.
GetPrimaryKey(IAddressable, String)	Returns the Guid representation of a grain primary key.
GetPrimaryKeyLong(IAddressable)	Returns the long representation of a grain primary key.
GetPrimaryKeyLong(IAddressable, String)	Returns the long representation of a grain primary key.
GetPrimaryKeyString(IAddressable)	Returns the string primary key of the grain.
IsPrimaryKeyBasedOnLong(IAddressable)	Returns whether part of the primary key is of type long.
GetReminder(Grain, String)	Returns a previously registered reminder.
GetReminder(IGrainBase, String)	Returns a previously registered reminder.
GetReminders(Grain)	Returns a list of all reminders registered by the grain.
GetReminders(IGrainBase)	Returns a list of all reminders registered by the grain.
RegisterOrUpdateReminder(Grain, String, TimeSpan, TimeSpan)	Registers a persistent, reliable reminder to send regular notifications (reminders) to the grain. The grain must implement the Orleans.IRemindable interface, and reminders for this grain will be sent to the ReceiveReminder callback method. If the current grain is deactivated when the timer fires, a new activation of this grain will be created to receive this reminder. If an existing reminder with the same name already exists, that reminder will be overwritten with this new reminder. Reminders will always be received by one activation of this grain, even if multiple activations exist for this grain.
RegisterOrUpdateReminder(IGrainBase, String, TimeSpan, TimeSpan)	Registers a persistent, reliable reminder to send regular notifications (reminders) to the grain. The grain must implement the Orleans.IRemindable interface, and reminders for this grain will be sent to the ReceiveReminder callback method. If the current grain is deactivated when the timer fires, a new activation of this grain will be created to receive this reminder. If an existing reminder with the same name already exists, that reminder will be overwritten with this new reminder. Reminders will always be received by one activation of this grain, even if multiple activations exist for this grain.
UnregisterReminder(Grain, IGrainReminder)	Unregisters a previously registered reminder.
UnregisterReminder(IGrainBase, IGrainReminder)	Unregisters a previously registered reminder.
GetStreamProvider(Grain, String)	Gets the stream provider with the specified name.
GetStreamProvider(IGrainBase, String)	Gets the stream provider with the specified name.