GrainTimerCreationOptions

1. Documentation
2. API reference
3. Microsoft.Orleans.Core.Abstractions
4. GrainTimerCreationOptions

struct

Namespace: Orleans.Runtime

NuGetSourceMarkdown

Options for creating grain timers.

public readonly struct GrainTimerCreationOptions : IEquatable<GrainTimerCreationOptions>

Constructors

• GrainTimerCreationOptions Options for creating grain timers.
• GrainTimerCreationOptions(TimeSpan, TimeSpan) Initializes a new GrainTimerCreationOptions instance.

Properties

• DueTime A System.TimeSpan representing the amount of time to delay before invoking the callback method specified when the IGrainTimer was constructed. Specify System.Threading.Timeout.InfiniteTimeSpan to prevent the timer from starting. Specify System.TimeSpan.Zero to start the timer immediately.
• Interleave Gets a value indicating whether callbacks scheduled by this timer are allowed to interleave execution with other timers and grain calls. Defaults to false.
• KeepAlive Gets a value indicating whether callbacks scheduled by this timer should extend the lifetime of the grain activation. Defaults to false.
• Period The time interval between invocations of the callback method specified when the IGrainTimer was constructed. Specify System.Threading.Timeout.InfiniteTimeSpan to disable periodic signaling.

Methods

• Equals(GrainTimerCreationOptions)Indicates whether the current object is equal to another object of the same type.
• Equals(object?)Indicates whether this instance and a specified object are equal.
• GetHashCodeReturns the hash code for this instance.
• operator ==(GrainTimerCreationOptions, GrainTimerCreationOptions) Determines whether two timer creation options are equal.
• operator !=(GrainTimerCreationOptions, GrainTimerCreationOptions) Determines whether two timer creation options are unequal.