defmodule Spoxy.Partitionable.Behaviour do
  @moduledoc """
  since `GenServer` based module, process its own mailbox messages in serial manner,
  it's subject to have a long queuing time in case the queue becomes big.

  In order to scale such modules, we introduce the `GenSpoxy.Partitionable` behaviour,
  it will be implemented by modules that require and suit a paritioning logic
  """

  @callback total_partitions() :: Integer

  @callback calc_req_partition(key :: String.t()) :: term

  @callback partition_server(key :: term) :: term
end