MingaEditor.EffectScheduler.Engine (Minga v0.1.0)

Lifecycle, admission-policy, and worker coordination for EffectScheduler.

Summary

Types

admission()

admission_error()

claim()

handoff()

Functions

active?(state, handler)

Returns whether a handler has running, queued, or pending work.

active_activity?(state, activity)

Returns whether any active request advertises a semantic activity.

active_source?(state, source)

Returns whether a source has running, queued, or pending work.

admitted?(state, request_id)

Returns whether an exact request still holds scheduler admission.

attach(state, owner)

Attaches the scheduler's single owner.

cancel(state, request_id)

Cancels an admitted request.

cancel_operation(state, operation_id)

Cancels the admitted request correlated with a semantic operation.

cancel_resource(state, resource)

Cancels and terminalizes all work for one semantic resource.

cancel_source(state, source)

Cancels and terminalizes all work attributed to a contribution source.

claim(state, outcome)

Atomically claims a still-pending candidate without releasing its resource.

finalize(state, outcome)

Finalizes a domain-applied candidate, if it is still pending.

finalize_and_schedule(state, outcome, request)

Finalizes a candidate and admits its follow-up as one scheduler transition.

process_down(state, ref, owner, reason)

Processes an owner or worker DOWN message.

schedule(state, request)

Admits a request according to its resource policy.

shutdown(state, reason)

Stops all work and terminalizes every admitted request.

stats(state)

Returns bounded scheduler statistics.

task_result(state, task_ref, result)

Processes a successful worker reply.

timeout(state, request_id)

Processes a scheduler-owned request timeout.

Types

admission()

@type admission() ::
  {:ok, MingaEditor.Effect.Request.id(), :running | :queued}
  | {:error, admission_error()}

admission_error()

@type admission_error() ::
  :already_admitted
  | :owner_unavailable
  | :policy_mismatch
  | :queue_full
  | :scheduler_full

claim()

@type claim() :: :ok | {:error, :not_pending}

handoff()

@type handoff() :: admission() | {:error, :not_found}

Functions

active?(state, handler)

@spec active?(MingaEditor.EffectScheduler.State.t(), module()) :: boolean()

Returns whether a handler has running, queued, or pending work.

active_activity?(state, activity)

@spec active_activity?(MingaEditor.EffectScheduler.State.t(), atom()) :: boolean()

Returns whether any active request advertises a semantic activity.

active_source?(state, source)

@spec active_source?(
  MingaEditor.EffectScheduler.State.t(),
  Minga.Extension.ContributionCleanup.contribution_source()
) :: boolean()

Returns whether a source has running, queued, or pending work.

admitted?(state, request_id)

@spec admitted?(
  MingaEditor.EffectScheduler.State.t(),
  MingaEditor.Effect.Request.id()
) :: boolean()

Returns whether an exact request still holds scheduler admission.

attach(state, owner)

@spec attach(MingaEditor.EffectScheduler.State.t(), pid()) ::
  {:ok | {:error, :already_attached}, MingaEditor.EffectScheduler.State.t()}

Attaches the scheduler's single owner.

cancel(state, request_id)

@spec cancel(MingaEditor.EffectScheduler.State.t(), MingaEditor.Effect.Request.id()) ::
  {:ok | {:error, :not_found}, MingaEditor.EffectScheduler.State.t()}

Cancels an admitted request.

cancel_operation(state, operation_id)

@spec cancel_operation(
  MingaEditor.EffectScheduler.State.t(),
  MingaEditor.State.Operation.id()
) ::
  {:ok | {:error, :not_found}, MingaEditor.EffectScheduler.State.t()}

Cancels the admitted request correlated with a semantic operation.

cancel_resource(state, resource)

@spec cancel_resource(
  MingaEditor.EffectScheduler.State.t(),
  MingaEditor.Effect.Request.resource()
) ::
  {:ok, MingaEditor.EffectScheduler.State.t()}

Cancels and terminalizes all work for one semantic resource.

cancel_source(state, source)

@spec cancel_source(
  MingaEditor.EffectScheduler.State.t(),
  Minga.Extension.ContributionCleanup.contribution_source()
) :: {:ok, MingaEditor.EffectScheduler.State.t()}

Cancels and terminalizes all work attributed to a contribution source.

claim(state, outcome)

@spec claim(MingaEditor.EffectScheduler.State.t(), MingaEditor.Effect.Outcome.t()) ::
  {claim(), MingaEditor.EffectScheduler.State.t()}

Atomically claims a still-pending candidate without releasing its resource.

finalize(state, outcome)

@spec finalize(MingaEditor.EffectScheduler.State.t(), MingaEditor.Effect.Outcome.t()) ::
  MingaEditor.EffectScheduler.State.t()

Finalizes a domain-applied candidate, if it is still pending.

finalize_and_schedule(state, outcome, request)

@spec finalize_and_schedule(
  MingaEditor.EffectScheduler.State.t(),
  MingaEditor.Effect.Outcome.t(),
  MingaEditor.Effect.Request.t()
) :: {handoff(), MingaEditor.EffectScheduler.State.t()}

Finalizes a candidate and admits its follow-up as one scheduler transition.

process_down(state, ref, owner, reason)

@spec process_down(MingaEditor.EffectScheduler.State.t(), reference(), pid(), term()) ::
  MingaEditor.EffectScheduler.State.t()

Processes an owner or worker DOWN message.

schedule(state, request)

@spec schedule(MingaEditor.EffectScheduler.State.t(), MingaEditor.Effect.Request.t()) ::
  {admission(), MingaEditor.EffectScheduler.State.t()}

Admits a request according to its resource policy.

shutdown(state, reason)

@spec shutdown(MingaEditor.EffectScheduler.State.t(), term()) ::
  MingaEditor.EffectScheduler.State.t()

Stops all work and terminalizes every admitted request.

stats(state)

@spec stats(MingaEditor.EffectScheduler.State.t()) :: map()

Returns bounded scheduler statistics.

task_result(state, task_ref, result)

@spec task_result(MingaEditor.EffectScheduler.State.t(), reference(), term()) ::
  MingaEditor.EffectScheduler.State.t()

Processes a successful worker reply.

timeout(state, request_id)

@spec timeout(MingaEditor.EffectScheduler.State.t(), MingaEditor.Effect.Request.id()) ::
  MingaEditor.EffectScheduler.State.t()

Processes a scheduler-owned request timeout.