MingaEditor.EffectScheduler (Minga v0.1.0)

Editor-generation-owned process wrapper for bounded slow effects.

Work is serialized by stable resource identity while unrelated resources run concurrently. Lifecycle, policy, admission, and worker transitions live in MingaEditor.EffectScheduler.Engine.

Summary

Types

admission()

admission_error()

cancel_error()

claim()

handoff()

server()

Scheduler server reference.

source()

Functions

active?(server, handler)

Returns whether the scheduler has running or queued work for a domain handler.

active_activity?(server, activity)

Returns whether any queued, running, or pending request advertises an activity.

active_source?(server, source)

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

admitted?(server, request_id)

Returns whether an exact request still holds scheduler admission.

attach(server, owner)

Attaches the single Editor owner for this scheduler generation.

cancel(server, request_id)

Cancels an admitted request by id.

cancel_operation(server, operation_id)

Cancels the admitted request correlated with a semantic operation.

cancel_resource(server, resource)

Cancels queued, running, and pending work for a semantic resource.

cancel_source(server, source)

Cancels queued, running, and pending work attributed to a source.

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

claim(server, outcome)

Claims a still-current candidate before its domain handler applies it.

finalize(server, outcome)

Finalizes the domain-applied terminal outcome exactly once.

finalize_and_schedule(server, outcome, request)

Atomically finalizes one candidate and admits its typed follow-up request.

schedule(server, request)

Admits a typed effect request under its declared bounded policy.

start_link(opts)

Starts an effect scheduler.

stats(server)

Returns bounded scheduler statistics without exposing queued payloads.

Types

admission()

@type admission() :: MingaEditor.EffectScheduler.Engine.admission()

admission_error()

@type admission_error() :: MingaEditor.EffectScheduler.Engine.admission_error()

cancel_error()

@type cancel_error() :: :not_found | :scheduler_unavailable

claim()

@type claim() :: MingaEditor.EffectScheduler.Engine.claim()

handoff()

@type handoff() :: MingaEditor.EffectScheduler.Engine.handoff()

server()

@type server() :: GenServer.server()

Scheduler server reference.

source()

@type source() :: Minga.Extension.ContributionCleanup.contribution_source()

Functions

active?(server, handler)

@spec active?(server() | nil, module()) :: boolean()

Returns whether the scheduler has running or queued work for a domain handler.

active_activity?(server, activity)

@spec active_activity?(server() | nil, atom()) :: boolean()

Returns whether any queued, running, or pending request advertises an activity.

active_source?(server, source)

@spec active_source?(server() | nil, source()) :: boolean()

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

admitted?(server, request_id)

@spec admitted?(server() | nil, MingaEditor.Effect.Request.id()) :: boolean()

Returns whether an exact request still holds scheduler admission.

attach(server, owner)

@spec attach(server(), pid()) :: :ok | {:error, :already_attached}

Attaches the single Editor owner for this scheduler generation.

cancel(server, request_id)

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

Cancels an admitted request by id.

cancel_operation(server, operation_id)

@spec cancel_operation(server() | nil, MingaEditor.State.Operation.id()) ::
  :ok | {:error, cancel_error()}

Cancels the admitted request correlated with a semantic operation.

cancel_resource(server, resource)

@spec cancel_resource(server() | nil, MingaEditor.Effect.Request.resource()) ::
  :ok | {:error, :scheduler_unavailable}

Cancels queued, running, and pending work for a semantic resource.

cancel_source(server, source)

@spec cancel_source(server() | nil, source()) ::
  :ok | {:error, :scheduler_unavailable}

Cancels queued, running, and pending work attributed to a source.

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

claim(server, outcome)

@spec claim(server(), MingaEditor.Effect.Outcome.t()) :: claim()

Claims a still-current candidate before its domain handler applies it.

finalize(server, outcome)

@spec finalize(server(), MingaEditor.Effect.Outcome.t()) :: :ok

Finalizes the domain-applied terminal outcome exactly once.

finalize_and_schedule(server, outcome, request)

@spec finalize_and_schedule(
  server(),
  MingaEditor.Effect.Outcome.t(),
  MingaEditor.Effect.Request.t()
) ::
  handoff()

Atomically finalizes one candidate and admits its typed follow-up request.

schedule(server, request)

@spec schedule(server(), MingaEditor.Effect.Request.t()) :: admission()

Admits a typed effect request under its declared bounded policy.

start_link(opts)

@spec start_link(keyword()) :: GenServer.on_start()

Starts an effect scheduler.

stats(server)

@spec stats(server()) :: %{
  resources: non_neg_integer(),
  running: non_neg_integer(),
  queued: non_neg_integer(),
  pending: non_neg_integer(),
  admitted: non_neg_integer(),
  capacity: pos_integer()
}

Returns bounded scheduler statistics without exposing queued payloads.