GrainReference Class

Definition

Namespace:

Orleans.Runtime

Assembly:

Orleans.Core.Abstractions.dll

Package:

Microsoft.Orleans.Core.Abstractions v8.2.0

This is the base class for all grain references.

[Orleans.Alias("GrainRef")]
[Orleans.DefaultInvokableBaseType(typeof(System.Threading.Tasks.ValueTask<>), typeof(Orleans.Runtime.Request<>))]
[Orleans.DefaultInvokableBaseType(typeof(System.Threading.Tasks.ValueTask), typeof(Orleans.Runtime.Request))]
[Orleans.DefaultInvokableBaseType(typeof(System.Threading.Tasks.Task<>), typeof(Orleans.Runtime.TaskRequest<>))]
[Orleans.DefaultInvokableBaseType(typeof(System.Threading.Tasks.Task), typeof(Orleans.Runtime.TaskRequest))]
[Orleans.DefaultInvokableBaseType(typeof(System.Void), typeof(Orleans.Runtime.VoidRequest))]
[Orleans.DefaultInvokableBaseType(typeof(System.Collections.Generic.IAsyncEnumerable<>), typeof(Orleans.Runtime.AsyncEnumerableRequest<>))]
public class GrainReference : IEquatable<Orleans.Runtime.GrainReference>, ISpanFormattable, Orleans.Runtime.IAddressable

[<Orleans.Alias("GrainRef")>]
[<Orleans.DefaultInvokableBaseType(typeof(System.Threading.Tasks.ValueTask<>), typeof(Orleans.Runtime.Request<>))>]
[<Orleans.DefaultInvokableBaseType(typeof(System.Threading.Tasks.ValueTask), typeof(Orleans.Runtime.Request))>]
[<Orleans.DefaultInvokableBaseType(typeof(System.Threading.Tasks.Task<>), typeof(Orleans.Runtime.TaskRequest<>))>]
[<Orleans.DefaultInvokableBaseType(typeof(System.Threading.Tasks.Task), typeof(Orleans.Runtime.TaskRequest))>]
[<Orleans.DefaultInvokableBaseType(typeof(System.Void), typeof(Orleans.Runtime.VoidRequest))>]
[<Orleans.DefaultInvokableBaseType(typeof(System.Collections.Generic.IAsyncEnumerable<>), typeof(Orleans.Runtime.AsyncEnumerableRequest<>))>]
type GrainReference = class
    interface IAddressable
    interface IEquatable<GrainReference>
    interface ISpanFormattable
    interface IFormattable

Public Class GrainReference
Implements IAddressable, IEquatable(Of GrainReference), ISpanFormattable

Inheritance

Object

GrainReference

Attributes

AliasAttribute DefaultInvokableBaseTypeAttribute

Implements

IAddressable IEquatable<GrainReference> IFormattable ISpanFormattable

Constructors

GrainReference(GrainReferenceShared, IdSpan)

Initializes a new instance of the GrainReference class.

Properties

CodecProvider	Gets the serialization codec provider.
CopyContextPool	Gets the serialization copy context pool.
GrainId	Gets the grain id.
InterfaceName	Gets the interface name.
InterfaceType	Gets the interface type.
InterfaceVersion	Gets the interface version.

Methods

Cast<TGrainInterface>()	Creates a new grain reference which implements the specified grain interface.
Equals(GrainReference)	Indicates whether the current object is equal to another object of the same type.
Equals(Object)	Tests this reference for equality to another object. Two grain references are equal if they both refer to the same grain.
GetHashCode()	Calculates a hash code for a grain reference.
GetInvokable<TInvokable>()
GetUniformHashCode()	Get a uniform hash code for this grain reference.
Invoke(IRequest)	Invokes the provided method.
InvokeAsync(IRequest)	Invokes the provided method.
InvokeAsync<T>(IRequest)	Invokes the provided method.
ToString()	Returns a string representation of this reference.

Operators

Equality(GrainReference, GrainReference)	Compares two references for equality. Two grain references are equal if they both refer to the same grain.
Inequality(GrainReference, GrainReference)	Compares two references for inequality. Two grain references are equal if they both refer to the same grain.

Explicit Interface Implementations

IFormattable.ToString(String, IFormatProvider)

ISpanFormattable.TryFormat(Span<Char>, Int32, ReadOnlySpan<Char>, IFormatProvider)

Extension Methods

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, String)	Returns the Guid representation of a grain primary key.
GetPrimaryKey(IAddressable)	Returns the Guid representation of a grain primary key.
GetPrimaryKeyLong(IAddressable, String)	Returns the long representation of a grain primary key.
GetPrimaryKeyLong(IAddressable)	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.