roger_ui v0.1.8 RogerUi.Roger behaviour

Contract to Roger calls

Link to this section Summary

Link to this section Callbacks

Link to this callback cancel_job(partition_name, queue_name)
cancel_job(partition_name :: String.t(), queue_name :: atom()) :: :ok
Link to this callback partitions()
partitions() :: nodes()
Link to this callback purge_queue(partition_name, queue_name)
purge_queue(partition_name :: String.t(), queue_name :: atom()) ::
  {:ok, %{message_count: integer()}}
Link to this callback queue_pause(partition_name, queue_name)
queue_pause(partition_name :: String.t(), queue_name :: atom()) :: :ok
Link to this callback queue_resume(partition_name, queue_name)
queue_resume(partition_name :: String.t(), queue_name :: atom()) :: :ok
Link to this callback queued_jobs(partition_name, queue_name)
queued_jobs(partition_name :: String.t(), queue_name :: atom()) :: [
  {node_name :: String.t(),
   [
     %Roger.Job{
       args: term(),
       execution_key: term(),
       id: term(),
       module: term(),
       queue_key: term(),
       queued_at: term(),
       retry_count: term(),
       started_at: term()
     }
   ]}
]
Link to this callback running_jobs()
running_jobs() :: jobs()
Link to this callback running_jobs(partition_name)
running_jobs(partition_name :: String.t()) :: [
  {node_name :: String.t(),
   [
     %Roger.Job{
       args: term(),
       execution_key: term(),
       id: term(),
       module: term(),
       queue_key: term(),
       queued_at: term(),
       retry_count: term(),
       started_at: term()
     }
   ]}
]