Grain<TGrainState> 类

定义

命名空间:

Orleans

程序集:

Orleans.Core.Abstractions.dll

包:

Microsoft.Orleans.Core.Abstractions v8.1.0

具有声明持久状态的 Grain 的基类。

public class Grain<TGrainState> : Orleans.Grain

type Grain<'GrainState> = class
    inherit Grain

Public Class Grain(Of TGrainState)
Inherits Grain

类型参数

TGrainState

持久状态对象的类

继承

Object

Grain

Grain<TGrainState>

构造函数

Grain<TGrainState>()	初始化 Grain<TGrainState> 类的新实例。
Grain<TGrainState>(IStorage<TGrainState>)	初始化 Grain<TGrainState> 类的新实例。

属性

GrainFactory	获取可用于访问其他粒度的 对象。 如果此粒度不与运行时关联，则为 Null，例如，直接创建用于单元测试时。 (继承自 Grain)
GrainReference	具有声明持久状态的 Grain 的基类。 (继承自 Grain)
IdentityString	grain 的 SiloIdentity 的字符串表示形式，包括类型和主键。 (继承自 Grain)
RuntimeIdentity	当前 silo 的唯一标识符。 此字符串没有语义内容，但它可能对日志记录很有用。 (继承自 Grain)
ServiceProvider	获取运行时管理的 IServiceProvider。 如果此粒度不与运行时关联，则为 Null，例如，直接创建用于单元测试时。 (继承自 Grain)
State	获取或设置粒度状态。

方法

ClearStateAsync()	从后备存储中清除当前粒度状态数据。
DeactivateOnIdle()	在完成当前 grain 方法调用后，停用 grain 的此激活。 此调用将标记当前粒度的此激活，以在当前方法的末尾停用和删除。 下一次调用此 grain 将导致使用不同的激活，这通常意味着运行时会自动创建新的激活。 (继承自 Grain)
DelayDeactivation(TimeSpan)	至少在指定的持续时间内延迟停用此激活。 正 timeSpan 值表示“在该时间跨度内阻止此激活的 GC”。 负 timeSpan 值表示“取消 DelayDeactivation 调用的先前设置，使此激活行为基于常规激活垃圾回收设置”。 DeactivateOnIdle 方法将撤消/替代任何当前“保持活动状态”设置，使此粒度立即可用于停用。 (继承自 Grain)
GetLogger()	返回此 grain 的代码可用于跟踪的记录器对象。 记录器的名称将派生自 grain 类名。 (继承自 Grain)
GetLogger(String)	返回此 grain 的代码可用于跟踪的记录器对象。 (继承自 Grain)
GetReminder(String)	返回以前注册的提醒。 (继承自 Grain)
GetReminders()	返回 grain 注册的所有提醒的列表。 (继承自 Grain)
GetStreamProvider(String)	具有声明持久状态的 Grain 的基类。 (继承自 Grain)
GetStreamProviders()	具有声明持久状态的 Grain 的基类。 (继承自 Grain)
MigrateOnIdle()	开始尝试将此实例迁移到另一个位置。 迁移捕获当前 RequestContext，使其可供激活的放置控制器使用，以便在选择新位置时可以考虑它。 当没有执行请求时，迁移将以异步方式进行;如果激活的放置控制器未选择备用位置，则不会发生迁移。 (继承自 Grain)
OnActivateAsync()	此方法在激活 grain 的过程结束时调用。 在将任何消息调度到 grain 之前调用它。 对于具有声明持久状态的粒度，在填充 State 属性后调用此方法。 (继承自 Grain)
OnActivateAsync(CancellationToken)	此方法在激活 grain 的过程结束时调用。 在将任何消息调度到 grain 之前调用它。 对于具有声明持久状态的粒度，在填充 State 属性后调用此方法。 (继承自 Grain)
OnDeactivateAsync()	在停用 grain 的过程开始时调用此方法。 (继承自 Grain)
OnDeactivateAsync(DeactivationReason, CancellationToken)	在停用 grain 的过程开始时调用此方法。 (继承自 Grain)
Participate(IGrainLifecycle)	具有声明持久状态的 Grain 的基类。 (继承自 Grain)
ReadStateAsync()	从后备存储读取 grain 状态，并 State更新 。
RegisterOrUpdateReminder(String, TimeSpan, TimeSpan)	注册持久可靠的提醒，以将常规通知 (提醒) 发送到粒度。 grain 必须实现 Orleans.IRemindable 接口，并且此 grain 的提醒将发送到 ReceiveReminder 回调方法。 如果在计时器触发时停用当前粒度，则将创建此 grain 的新激活来接收此提醒。 如果已存在同名的现有提醒，则此新提醒将覆盖该提醒。 此 grain 的一次激活始终会收到提醒，即使此 grain 存在多个激活也是如此。 (继承自 Grain)
RegisterTimer(Func<Object,Task>, Object, TimeSpan, TimeSpan)	注册计时器以向此 grain 发送定期回调。 (继承自 Grain)
UnregisterReminder(IGrainReminder)	取消注册以前注册的提醒。 (继承自 Grain)
WriteStateAsync()	将当前粒度状态数据写入后备存储。

显式接口实现

IGrainBase.GrainContext

具有声明持久状态的 Grain 的基类。 (继承自 Grain)

扩展方法

DeactivateOnIdle(IGrainBase)	在当前 grain 方法调用完成后停用此 grain 激活。 此调用将标记当前粒度的此激活，以在当前方法的末尾停用和删除。 下一次调用此 grain 将导致使用不同的激活，这通常意味着运行时会自动创建新的激活。
MigrateOnIdle(IGrainBase)	开始尝试将此实例迁移到另一个位置。 迁移捕获当前 RequestContext，使其可供激活的放置控制器使用，以便在选择新位置时可以考虑它。 当没有执行请求时，迁移将以异步方式进行;如果激活的放置控制器未选择备用位置，则不会发生迁移。
AsReference(IAddressable, Type)	返回对提供的 grain 的类型化引用。
AsReference<TGrainInterface>(IAddressable)	返回对提供的 grain 的类型化引用。
Cast(IAddressable, Type)	返回对提供的 grain 的类型化引用。
Cast<TGrainInterface>(IAddressable)	返回对提供的 grain 的类型化引用。
GetGrainId(IAddressable)	返回与提供的 grain 对应的 grain ID。
GetPrimaryKey(IAddressable)	返回 Guid grain 主键的表示形式。
GetPrimaryKey(IAddressable, String)	返回 Guid grain 主键的表示形式。
GetPrimaryKeyLong(IAddressable)	返回 long grain 主键的表示形式。
GetPrimaryKeyLong(IAddressable, String)	返回 long grain 主键的表示形式。
GetPrimaryKeyString(IAddressable)	返回 string grain 的主键。
IsPrimaryKeyBasedOnLong(IAddressable)	返回主键的一部分是否为 类型 long。
GetReminder(Grain, String)	返回以前注册的提醒。
GetReminder(IGrainBase, String)	返回以前注册的提醒。
GetReminders(Grain)	返回 grain 注册的所有提醒的列表。
GetReminders(IGrainBase)	返回 grain 注册的所有提醒的列表。
RegisterOrUpdateReminder(Grain, String, TimeSpan, TimeSpan)	注册持久可靠的提醒，以将常规通知 (提醒) 发送到粒度。 grain 必须实现 Orleans.IRemindable 接口，并且此 grain 的提醒将发送到 ReceiveReminder 回调方法。 如果在计时器触发时停用当前粒度，则将创建此 grain 的新激活来接收此提醒。 如果已存在同名的现有提醒，则此新提醒将覆盖该提醒。 此 grain 的一次激活始终会收到提醒，即使此 grain 存在多个激活也是如此。
RegisterOrUpdateReminder(IGrainBase, String, TimeSpan, TimeSpan)	注册持久可靠的提醒，以将常规通知 (提醒) 发送到粒度。 grain 必须实现 Orleans.IRemindable 接口，并且此 grain 的提醒将发送到 ReceiveReminder 回调方法。 如果在计时器触发时停用当前粒度，则将创建此 grain 的新激活来接收此提醒。 如果已存在同名的现有提醒，则此新提醒将覆盖该提醒。 此 grain 的一次激活始终会收到提醒，即使此 grain 存在多个激活也是如此。
UnregisterReminder(Grain, IGrainReminder)	取消注册以前注册的提醒。
UnregisterReminder(IGrainBase, IGrainReminder)	取消注册以前注册的提醒。
GetStreamProvider(Grain, String)	获取具有指定 name的流提供程序。
GetStreamProvider(IGrainBase, String)	获取具有指定 name的流提供程序。