feature/work/com.shifthackz.aisdv1.work.core/CoreGenerationWorker

CoreGenerationWorker

internal abstract class CoreGenerationWorker(context: Context, workerParameters: WorkerParameters, pushNotificationManager: PushNotificationManager, activityIntentProvider: ActivityIntentProvider, val preferenceManager: PreferenceManager, val backgroundWorkObserver: BackgroundWorkObserver, val observeHordeProcessStatusUseCase: ObserveHordeProcessStatusUseCase, val observeLocalDiffusionProcessStatusUseCase: ObserveLocalDiffusionProcessStatusUseCase, val observeBonsaiProcessStatusUseCase: ObserveBonsaiProcessStatusUseCase, val interruptGenerationUseCase: InterruptGenerationUseCase) : NotificationWorker(source)

Shared foreground worker base for generation tasks.

It owns cancellation, progress subscriptions, foreground notifications, and background observer updates that are common to txt2img and img2img work.

Inheritors

ImageToImageTask

TextToImageTask

Constructors

CoreGenerationWorker

constructor(context: Context, workerParameters: WorkerParameters, pushNotificationManager: PushNotificationManager, activityIntentProvider: ActivityIntentProvider, preferenceManager: PreferenceManager, backgroundWorkObserver: BackgroundWorkObserver, observeHordeProcessStatusUseCase: ObserveHordeProcessStatusUseCase, observeLocalDiffusionProcessStatusUseCase: ObserveLocalDiffusionProcessStatusUseCase, observeBonsaiProcessStatusUseCase: ObserveBonsaiProcessStatusUseCase, interruptGenerationUseCase: InterruptGenerationUseCase)

Properties

activityIntentProvider

private val activityIntentProvider: ActivityIntentProvider

Exposes the activityIntentProvider value used by the SDAI background work feature layer.

applicationContext

val applicationContext: @NonNull Context

backgroundExecutor

@get:RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

open val backgroundExecutor: @NonNull Executor

backgroundWorkObserver

private val backgroundWorkObserver: BackgroundWorkObserver

coroutineContext

open val ~~coroutineContext~~: CoroutineDispatcher

private val coroutineScope: CoroutineScope

foregroundInfoAsync

val foregroundInfoAsync: ListenableFuture<ForegroundInfo>

genericNotificationId

abstract val genericNotificationId: Int

Exposes the genericNotificationId value used by the SDAI background work feature layer.

val id: @NonNull UUID

val inputData: @NonNull Data

interruptGenerationUseCase

private val interruptGenerationUseCase: InterruptGenerationUseCase

val isStopped: Boolean

@get:RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

val isUsed: Boolean

private var mAppContext: @NonNull Context

private val mStopReason: AtomicInteger?

private var mUsed: Boolean

private var mWorkerParams: @NonNull WorkerParameters

@get:RequiresApi(value = 28)

val network: @Nullable Network?

abstract val notificationId: Int

Exposes the notificationId value used by the SDAI background work feature layer.

observeBonsaiProcessStatusUseCase

private val observeBonsaiProcessStatusUseCase: ObserveBonsaiProcessStatusUseCase

observeHordeProcessStatusUseCase

private val observeHordeProcessStatusUseCase: ObserveHordeProcessStatusUseCase

observeLocalDiffusionProcessStatusUseCase

private val observeLocalDiffusionProcessStatusUseCase: ObserveLocalDiffusionProcessStatusUseCase

private val params: WorkerParameters

preferenceManager

private val preferenceManager: PreferenceManager

pushNotificationManager

private val pushNotificationManager: PushNotificationManager

Exposes the pushNotificationManager value used by the SDAI background work feature layer.

runAttemptCount

@get:IntRange(from = 0)

val runAttemptCount: Int

protected val source: ServerSource

@get:RequiresApi(value = 31)

val stopReason: Int

val tags: @NonNull Set<String?>

@get:RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

open val taskExecutor: @NonNull TaskExecutor

triggeredContentAuthorities

@get:RequiresApi(value = 24)

val triggeredContentAuthorities: @NonNull List<String?>

triggeredContentUris

@get:RequiresApi(value = 24)

val triggeredContentUris: @NonNull List<Uri?>

@get:RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

open val workerFactory: @NonNull WorkerFactory

Functions

clearSubscriptions

protected fun clearSubscriptions()

abstract suspend fun doWork(): ListenableWorker.Result

getForegroundInfo

open suspend fun getForegroundInfo(): ForegroundInfo

getForegroundInfoAsync

override fun getForegroundInfoAsync(): ListenableFuture<ForegroundInfo>

handleCancellation

protected suspend fun handleCancellation()

protected fun handleError(t: Throwable)

protected fun handleProcess()

protected fun handleStart()

protected fun handleSuccess(result: List<AiGenerationResult>)

listenBonsaiStatus

protected fun listenBonsaiStatus()

listenHordeStatus

protected fun listenHordeStatus()

listenLocalDiffusionStatus

protected fun listenLocalDiffusionStatus()

listenSourceStatus

protected fun listenSourceStatus()

override fun onStopped()

suspend fun setForeground(foregroundInfo: ForegroundInfo)

setForegroundAsync

fun setForegroundAsync(foregroundInfo: @NonNull ForegroundInfo): @NonNull ListenableFuture<Void?>

setForegroundNotification

fun setForegroundNotification(title: String, body: String, subText: String? = null, progress: Pair<Int, Int>? = null, silent: Boolean = false, canCancel: Boolean = false)

Executes the setForegroundNotification step in the SDAI background work feature layer.

suspend fun setProgress(data: Data)

setProgressAsync

open fun setProgressAsync(data: @NonNull Data): @NonNull ListenableFuture<Void?>

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

showGenericNotification

fun showGenericNotification(text: String, body: String?)

Executes the showGenericNotification step in the SDAI background work feature layer.

override fun startWork(): ListenableFuture<ListenableWorker.Result>

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

fun stop(reason: Int)