SystemTargetGrainId Methods

Identifies a system target.

CompareTo(SystemTargetGrainId)

public int CompareTo(SystemTargetGrainId other)

Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.

Parameters

otherSystemTargetGrainId: An object to compare with this instance.

Returns

A value that indicates the relative order of the objects being compared. The return value has these meanings:

Value	Meaning
Less than zero	This instance precedes `other` in the sort order.
Zero	This instance occurs in the same position in the sort order as `other`.
Greater than zero	This instance follows `other` in the sort order.

Create(GrainType, SiloAddress)

static

View source

public static SystemTargetGrainId Create(GrainType kind, SiloAddress address)

Creates a new SystemTargetGrainId instance.

Parameters

kindGrainType: The grain type.
addressSiloAddress: The server which the system target exists on.

Returns

A SystemTargetGrainId.

Create(GrainType, SiloAddress, string?)

static

View source

public static SystemTargetGrainId Create(GrainType kind, SiloAddress address, string? extraIdentifier)

Creates a new SystemTargetGrainId instance.

Parameters

kindGrainType: The grain type.
addressSiloAddress: The server which the system target exists on.
extraIdentifierstring?: An optional key extension.

Returns

A SystemTargetGrainId.

CreateGrainServiceGrainId(int, string, SiloAddress)

static

View source

public static GrainId CreateGrainServiceGrainId(int typeCode, string grainSystemId, SiloAddress address)

Creates a SystemTargetGrainId for a grain service.

Parameters

typeCodeint: The type code.
grainSystemIdstring: The system id.
addressSiloAddress: The silo address.

Returns

A grain id for a grain service instance.

CreateGrainType(string)

static

View source

public static GrainType CreateGrainType(string name)

Creates a system target GrainType with the provided name.

Parameters

namestring: The system target grain type name.

Returns

The grain type.

Equals(SystemTargetGrainId)

View source

public bool Equals(SystemTargetGrainId other)

Indicates whether the current object is equal to another object of the same type.

Parameters

otherSystemTargetGrainId: An object to compare with this object.

Returns

true if the current object is equal to the other parameter; otherwise, false.

Equals(object?)

override

View source

public override bool Equals(object? obj)

Indicates whether this instance and a specified object are equal.

Parameters

objobject?: The object to compare with the current instance.

Returns

true if obj and this instance are the same type and represent the same value; otherwise, false.

GetHashCode

override

View source

public override int GetHashCode()

Returns the hash code for this instance.

Returns

A 32-bit signed integer that is the hash code for this instance.

GetSiloAddress

View source

public SiloAddress GetSiloAddress()

Gets the SiloAddress of the system target.

Returns

The silo address corresponding to this system target id.

IsSystemTargetGrainId(GrainId)

static

View source

public static bool IsSystemTargetGrainId(in GrainId id)

Returns true if the provided instance represents a system target, false if otherwise.

Parameters

idGrainId: The grain id.

Returns

true if the value is a system target grain id, false otherwise.

ToString

override

View source

public override string ToString()

Returns the fully qualified type name of this instance.

Returns

The fully qualified type name.

TryParse(GrainId, SystemTargetGrainId)

static

View source

public static bool TryParse(GrainId grainId, out SystemTargetGrainId systemTargetId)

Converts the provided SystemTargetGrainId to a SystemTargetGrainId. A return value indicates whether the operation succeeded.

Parameters

grainIdGrainId: The grain id.
systemTargetIdSystemTargetGrainId: The resulting system target id.

Returns

true if the value is a system target grain id, false otherwise.

WithSiloAddress(SiloAddress)

View source

public SystemTargetGrainId WithSiloAddress(SiloAddress siloAddress)

Returns a new SystemTargetGrainId targeting the provided address.

Parameters

siloAddressSiloAddress: The silo address.

Returns

A new SystemTargetGrainId targeting the provided address.

operator ==(SystemTargetGrainId, SystemTargetGrainId)

static

View source

public static bool operator ==(SystemTargetGrainId left, SystemTargetGrainId right)

Compares the provided operands for equality.

Parameters

leftSystemTargetGrainId: The left operand.
rightSystemTargetGrainId: The right operand.

Returns

true if the provided values are equal, otherwise false.

operator >(SystemTargetGrainId, SystemTargetGrainId)

static

View source

public static bool operator >(SystemTargetGrainId left, SystemTargetGrainId right)

Compares the provided operands and returns true if the left operand is greater than the right operand, otherwise false.

Parameters

leftSystemTargetGrainId: The left operand.
rightSystemTargetGrainId: The right operand.

Returns

true if the left operand is greater than the right operand, otherwise false.

operator >=(SystemTargetGrainId, SystemTargetGrainId)

static

View source

public static bool operator >=(SystemTargetGrainId left, SystemTargetGrainId right)

Compares the provided operands and returns true if the left operand is greater than or equal to the right operand, otherwise false.

Parameters

leftSystemTargetGrainId: The left operand.
rightSystemTargetGrainId: The right operand.

Returns

true if the left operand is greater than or equal to the right operand, otherwise false.

operator !=(SystemTargetGrainId, SystemTargetGrainId)

static

View source

public static bool operator !=(SystemTargetGrainId left, SystemTargetGrainId right)

Compares the provided operands for inequality.

Parameters

leftSystemTargetGrainId: The left operand.
rightSystemTargetGrainId: The right operand.

Returns

true if the provided values are not equal, otherwise false.

operator <(SystemTargetGrainId, SystemTargetGrainId)

static

View source

public static bool operator <(SystemTargetGrainId left, SystemTargetGrainId right)

Compares the provided operands and returns true if the left operand is less than the right operand, otherwise false.

Parameters

leftSystemTargetGrainId: The left operand.
rightSystemTargetGrainId: The right operand.

Returns

true if the left operand is less than the right operand, otherwise false.

operator <=(SystemTargetGrainId, SystemTargetGrainId)

static

View source

public static bool operator <=(SystemTargetGrainId left, SystemTargetGrainId right)

Compares the provided operands and returns true if the left operand is less than or equal to the right operand, otherwise false.

Parameters

leftSystemTargetGrainId: The left operand.
rightSystemTargetGrainId: The right operand.

Returns

true if the left operand is less than or equal to the right operand, otherwise false.