Struct SchedulerHandle

Namespace

Ceres.Schedulers

Assembly

Ceres.dll

Handle give you access to track scheduled task

public readonly struct SchedulerHandle : IDisposable

Implements

IDisposable

Inherited Members

ValueType.ToString()

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Extension Methods

SchedulerExtensions.WaitAsync(SchedulerHandle, CancellationToken, bool)

DisposableExtensions.AddTo<T>(T, IDisposableUnregister)

Constructors

SchedulerHandle(ulong)

public SchedulerHandle(ulong handle)

Parameters

handle ulong

SchedulerHandle(ulong, int)

public SchedulerHandle(ulong serialNum, int index)

Parameters

serialNum ulong

index int

Fields

IndexBits

public const int IndexBits = 24

Field Value

int

MaxIndex

public const int MaxIndex = 16777216

Field Value

int

MaxSerialNumber

public const ulong MaxSerialNumber = 1099511627776

Field Value

ulong

SerialNumberBits

public const int SerialNumberBits = 40

Field Value

int

Properties

Handle

Handle id for scheduled task

public ulong Handle { get; }

Property Value

ulong

Methods

Cancel()

Cancel a scheduled task if is valid

public void Cancel()

Dispose()

public void Dispose()

Equals(object)

public override bool Equals(object obj)

Parameters

obj object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

GetIndex()

public int GetIndex()

Returns

int

GetSerialNumber()

public ulong GetSerialNumber()

Returns

ulong

IsDone()

Get scheduled task whether is done

public bool IsDone()

Returns

bool

IsValid()

Get scheduled task whether is valid

public bool IsValid()

Returns

bool

Pause()

Pause a scheduled task if is valid

public void Pause()

Resume()

Resume a scheduled task if is valid

public void Resume()

Operators

operator ==(SchedulerHandle, SchedulerHandle)

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

Parameters

left SchedulerHandle

right SchedulerHandle

Returns

bool

operator !=(SchedulerHandle, SchedulerHandle)

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

Parameters

left SchedulerHandle

right SchedulerHandle

Returns

bool