Jabbit/tech.ryadom.jabbit

Package-level declarations

Everything an application touches: the jabbit { } builder, job types and requests, workers and their results, and the Jabbit instance that schedules and reports on them.

Types

AndroidScope

class AndroidScope

Android side of the jabbit { } builder.

BackoffPolicy

enum BackoffPolicy : Enum<BackoffPolicy>

How the delay before a retry grows after a job returns JobResult.Retry or is interrupted.

BrowserScope

class BrowserScope

Browser side of the jabbit { } builder. Mirrors JabbitBrowserOptions.

Constraints

data class Constraints(val requiredNetworkType: NetworkType = NetworkType.NOT_REQUIRED, val requiresCharging: Boolean = false, val requiresBatteryNotLow: Boolean = false, val requiresStorageNotLow: Boolean = false, val requiresDeviceIdle: Boolean = false)

Device conditions that must hold before a job is allowed to run.

ConstraintsScope

class ConstraintsScope

Scope of the constraints builder function.

DesktopJabbit

interface DesktopJabbit : Jabbit, AutoCloseable

The desktop Jabbit, which owns the resources it needs and can hand them back.

DesktopScope

class DesktopScope

Desktop side of the jabbit { } builder. Mirrors JabbitDesktopOptions.

ExistingJobPolicy

enum ExistingJobPolicy : Enum<ExistingJobPolicy>

How Jabbit.enqueueUnique resolves a collision with an unfinished job of the same unique name.

ExistingPeriodicJobPolicy

enum ExistingPeriodicJobPolicy : Enum<ExistingPeriodicJobPolicy>

How Jabbit.enqueueUniquePeriodic resolves a collision with an unfinished periodic job of the same unique name.

FileJabbitStorage

class FileJabbitStorage(file: Path) : JabbitStorage

JabbitStorage backed by a file on disk. This is the default on the desktop.

IndexedDbJabbitStorage

class IndexedDbJabbitStorage(databaseName: String = DEFAULT_DATABASE, storeName: String = DEFAULT_STORE, key: String = DEFAULT_KEY) : JabbitStorage

JabbitStorage backed by IndexedDB. This is the default on the web.

IosScope

class IosScope

iOS side of the jabbit { } builder. Mirrors JabbitIosOptions.

Jabbit

interface Jabbit

Schedules background jobs and reports on them.

JabbitDelegatingWorker

class JabbitDelegatingWorker(appContext: Context, parameters: WorkerParameters) : CoroutineWorker

The single androidx.work.ListenableWorker every Jabbit job is scheduled as.

JabbitDsl

@DslMarker

annotation class JabbitDsl

Marks the receivers of the jabbit { } builder so that nested blocks cannot see each other.

JabbitListener

interface JabbitListener

Watches what happens to jobs, for logging, analytics and crash reporting.

JabbitLogger

fun interface JabbitLogger

Sink for the diagnostic output of the scheduler.

JabbitScope

class JabbitScope

Receiver of the jabbit { } builder.

JabbitStorage

interface JabbitStorage

Persistence used by the platforms where Jabbit owns the job queue itself, currently iOS and the browser.

JabbitStorageException

class JabbitStorageException(message: String) : RuntimeException

Raised when the browser refuses to read or write the job queue.

JabbitWorker

fun interface JabbitWorker<I, O>

A unit of background work, typed by the payload it takes and the payload it returns.

JobExecution

class JobExecution<I>

Everything a running job knows about itself.

JobId

@JvmInline

value class JobId(val value: String)

Stable identifier of a single enqueued job.

JobInfo

data class JobInfo

Snapshot of an enqueued job.

JobProgress

@Serializable

data class JobProgress(val fraction: Float? = null, val message: String? = null)

What a running job reports about how far along it is.

JobRequest

sealed class JobRequest

A unit of background work handed to Jabbit.enqueue.

JobResult

sealed class JobResult<out O>

Outcome a worker reports at the end of JabbitWorker.doWork.

JobState

enum JobState : Enum<JobState>

Lifecycle state of an enqueued job.

JobType

class JobType<I, O>

Describes one kind of job: the name it is persisted under, and the payloads it accepts and produces.

LocalStorageJabbitStorage

class LocalStorageJabbitStorage(key: String = "tech.ryadom.jabbit.jobs") : JabbitStorage

JabbitStorage backed by localStorage.

NetworkType

enum NetworkType : Enum<NetworkType>

Network condition a job requires before it may run.

OneTimeJobRequest

class OneTimeJobRequest : JobRequest

A job that runs once.

PeriodicJobRequest

class PeriodicJobRequest : JobRequest

A job that repeats until it is cancelled or fails.

ProgressReporter

fun interface ProgressReporter

Receiver of JobExecution.setProgress calls.

UserDefaultsJabbitStorage

class UserDefaultsJabbitStorage(defaults: NSUserDefaults = NSUserDefaults.standardUserDefaults, key: String = DEFAULT_KEY) : JabbitStorage

JabbitStorage backed by NSUserDefaults.

Functions

constraints

fun constraints(block: ConstraintsScope.() -> Unit): Constraints

Builds Constraints with a DSL.

jabbit

fun jabbit(configure: JabbitScope.() -> Unit): Jabbit

Creates a Jabbit for whichever platform the code is running on, from a single description that lives in common code.

jobType

inline fun <I, O> jobType(name: String): JobType<I, O>

Declares a JobType named name, taking I and producing O.

oneTimeJob

fun <O> oneTimeJob(type: JobType<Unit, O>, configure: OneTimeJobRequest.Builder.() -> Unit = {}): OneTimeJobRequest

Builds a OneTimeJobRequest for a job that needs no input.

fun <I, O> oneTimeJob(type: JobType<I, O>, input: I, configure: OneTimeJobRequest.Builder.() -> Unit = {}): OneTimeJobRequest

Builds a OneTimeJobRequest running type with input.

output

fun <O> JobInfo.output(type: JobType<*, O>): O?

Reads what the job produced, or null when it has not succeeded yet.

periodicJob

fun <O> periodicJob(type: JobType<Unit, O>, repeatInterval: Duration, configure: PeriodicJobRequest.Builder.() -> Unit = {}): PeriodicJobRequest

Builds a PeriodicJobRequest for a job that needs no input.

fun <I, O> periodicJob(type: JobType<I, O>, input: I, repeatInterval: Duration, configure: PeriodicJobRequest.Builder.() -> Unit = {}): PeriodicJobRequest

Builds a PeriodicJobRequest running type with input every repeatInterval.

periodicJobMillis

fun <O> periodicJobMillis(type: JobType<Unit, O>, repeatIntervalMillis: Long, configure: PeriodicJobRequest.Builder.() -> Unit = {}): PeriodicJobRequest

Builds a PeriodicJobRequest for a job that needs no input, repeating every repeatIntervalMillis milliseconds.

fun <I, O> periodicJobMillis(type: JobType<I, O>, input: I, repeatIntervalMillis: Long, configure: PeriodicJobRequest.Builder.() -> Unit = {}): PeriodicJobRequest

Builds a PeriodicJobRequest repeating every repeatIntervalMillis milliseconds, for callers without kotlin.time.Duration.

requestPersistentStorage

suspend fun requestPersistentStorage(): Boolean

Asks the browser to keep this origin's storage, and reports whether it now will.

startJabbitServiceWorker

fun startJabbitServiceWorker(configure: JabbitScope.() -> Unit)

Runs pending jobs inside a service worker, so they continue after the last page is closed.