Struct ScheduledTickHandle

Opaque handle returned by Schedule(long, Action, long, ScheduleMode). The caller passes the handle back to Cancel(ScheduledTickHandle) to revoke a scheduled callback before it fires.

Implements
Inherited Members
Namespace: Scylla.Core.Time
Assembly: ScyllaCore.dll
Syntax
public readonly struct ScheduledTickHandle : IEquatable<ScheduledTickHandle>

Constructors

ScheduledTickHandle(int)

Wraps a scheduler-assigned ID into a handle.

Declaration
public ScheduledTickHandle(int id)
Parameters
Type Name Description
int id

Properties

ID

Sequential identifier assigned by the originating scheduler.

Declaration
public int ID { get; }
Property Value
Type Description
int

IsValid

True when this handle holds a non-default identifier.

Declaration
public bool IsValid { get; }
Property Value
Type Description
bool

Methods

Equals(ScheduledTickHandle)

Returns true when this handle's ID equals other's ID.

Declaration
public bool Equals(ScheduledTickHandle other)
Parameters
Type Name Description
ScheduledTickHandle other
Returns
Type Description
bool

Equals(object)

Returns true when obj is a ScheduledTickHandle with the same ID.

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
object obj
Returns
Type Description
bool
Overrides

GetHashCode()

Returns the ID as the hash code. Consistent with Equals(ScheduledTickHandle).

Declaration
public override int GetHashCode()
Returns
Type Description
int
Overrides

Operators

operator ==(ScheduledTickHandle, ScheduledTickHandle)

Returns true when both handles refer to the same scheduled entry.

Declaration
public static bool operator ==(ScheduledTickHandle a, ScheduledTickHandle b)
Parameters
Type Name Description
ScheduledTickHandle a
ScheduledTickHandle b
Returns
Type Description
bool

operator !=(ScheduledTickHandle, ScheduledTickHandle)

Returns true when the handles refer to different scheduled entries.

Declaration
public static bool operator !=(ScheduledTickHandle a, ScheduledTickHandle b)
Parameters
Type Name Description
ScheduledTickHandle a
ScheduledTickHandle b
Returns
Type Description
bool

Implements