Class JobSignals

java.lang.Object

com.kingsrook.qqq.backend.core.jobs.runtime.JobSignals

public final class JobSignals
extends Object

Everything a job tells the outside world: realtime events (job.status on every change, job.progress throttled to one per second per job - counts only, never row values), alerts (jobs.job-failed, jobs.job-stalled) and the owner's completion notification. All best effort: a signal failure never fails a job. Core never depends on qbit-alerts; QAlerts routes to whatever sink the app installed.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ALERT_EFFECT_UNRESOLVED
static final String	ALERT_JOB_FAILED
static final String	ALERT_JOB_STALLED
static final String	EVENT_PROGRESS
static final String	EVENT_STATUS
static final String	HEARTBEAT_REAPER

Method Summary

Modifier and Type	Method	Description
static void	effectResolved(Integer effectId, String how)	Resolve an effect's review alert.
static void	effectUnresolved(QRecord effect)	Raise the alert for an outbox effect whose delivery could not be determined and that is queued for review (deduped per effect).
static void	finished(QRecord job, JobStatus status)	A job reached a final (or review) status: notify its owner, raise or resolve the failure alert, publish status.
static void	progress(QRecord job, boolean force)	Publish job.progress (at most once per second per job unless forced).
static void	stalled(QRecord job, String why)	Raise the stalled alert for a job.
static void	status(Integer jobId, String userId, JobStatus status)	Publish job.status to the job's record channel and the owner's user channel.
static void	unstalled(Integer jobId)	Resolve the stalled alert for a job (it moved again).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ALERT_JOB_FAILED

public static final String ALERT_JOB_FAILED

See Also:

• Constant Field Values

ALERT_JOB_STALLED

public static final String ALERT_JOB_STALLED

See Also:

• Constant Field Values

ALERT_EFFECT_UNRESOLVED

public static final String ALERT_EFFECT_UNRESOLVED

See Also:

• Constant Field Values

HEARTBEAT_REAPER

public static final String HEARTBEAT_REAPER

See Also:

• Constant Field Values

EVENT_STATUS

public static final String EVENT_STATUS

See Also:

• Constant Field Values

EVENT_PROGRESS

public static final String EVENT_PROGRESS

See Also:

• Constant Field Values

Method Details

status

public static void status(Integer jobId,
 String userId,
 JobStatus status)

Publish job.status to the job's record channel and the owner's user channel.

progress

public static void progress(QRecord job,
 boolean force)

Publish job.progress (at most once per second per job unless forced).

finished

public static void finished(QRecord job,
 JobStatus status)

A job reached a final (or review) status: notify its owner, raise or resolve the failure alert, publish status.

stalled

public static void stalled(QRecord job,
 String why)

Raise the stalled alert for a job.

effectUnresolved

public static void effectUnresolved(QRecord effect)

Raise the alert for an outbox effect whose delivery could not be determined and that is queued for review (deduped per effect).

effectResolved

public static void effectResolved(Integer effectId,
 String how)

Resolve an effect's review alert.

unstalled

public static void unstalled(Integer jobId)

Resolve the stalled alert for a job (it moved again).