Anvil.Queue.Policy behaviour (Anvil v0.1.1)

Behaviour for queue assignment policies.

Policies control how samples are assigned to labelers.

Summary

policy_state()

sample()

init(config)

Initializes policy state based on the policy type.

Returns the next sample for a labeler based on the policy.

Updates the policy state after an assignment.

@type policy_state() :: map()

@type sample() :: map()

@callback init(config :: map()) :: {:ok, policy_state()}

@callback next_assignment(
  policy_state(),
  labeler_id :: String.t(),
  available_samples :: [sample()]
) :: {:ok, sample()} | {:error, atom()}

@callback update_state(policy_state(), sample()) :: policy_state()

@spec init_policy(atom() | module(), map()) :: {:ok, map()}

Initializes policy state based on the policy type.

Dispatches to the appropriate policy module.

@spec next_sample(atom() | module(), map(), String.t(), [map()]) ::
  {:ok, map()} | {:error, atom()}

Returns the next sample for a labeler based on the policy.

Dispatches to the appropriate policy module.

@spec update_state(atom() | module(), map(), map()) :: map()

Updates the policy state after an assignment.