EffectScheduler

Represents a queue of effects to be processed.

Kind: Class

Namespace: CrowdControl.Games

Public Constructors

EffectScheduler()

Public Member Functions

int?

GetQueueLimit()

Gets the maximum number of effects that can be queued globally.

int?

GetQueueLimit(string identifier, IdentifierType identifierType)

Gets the maximum number of effects that can be queued globally.

void

SetQueueLimit(int limit)

Sets the maximum number of effects that can be queued globally.

void

SetQueueLimit(string identifier, IdentifierType identifierType, int? limit)

Sets the maximum number of effects that can be queued globally.

Task

AddFailureRejection(Guid guid)

Adds a failure rejection for the specified request ID.

Task>

TryEnqueue(IEffectPackProcessable request)

Attempts to enqueue a request for processing.

Task>

TryEnqueue(IEffectPackProcessable request, SITimeSpan delay)

Attempts to enqueue a request for processing.

Task>

TryEnqueue(IEffectPackProcessable request, DateTimeOffset dueTime)

Attempts to enqueue a request for processing.

Task

TryDequeue()

Attempts to dequeue the next request from the queue.

bool

TryRemove(Guid id, IEffectPackProcessable out value)

Attempts to remove a request from the queue.

Task>

TryRemove(Guid id)

Attempts to remove a request from the queue.

Task

Clear()

Clears the queue of all requests.

IEnumerator

GetEnumerator()

Properties

SchedulingStrategy

GroupStrategy

[get, set]

The scheduling strategy for effect groups.

SchedulingStrategy

CategoryStrategy

[get, set]

The scheduling strategy for effect categories.

static

int

DefaultQueueLimit

[get, set]

The default limit for the number of effects in the queue.