Skip to content

How to auto cancel UseCase job when the ViewModel is destroyed #118

Open
@rommansabbir

Description

@rommansabbir

I want to auto cancel all UseCase request that is tied to the ViewModel.

For now: I have reigstered a callback for ViewModel.onCleared() event. So when the onCleared() is called, the callback will be invoked.

class BaseViewModel : ViewModel(){
    internal var onClearedListener : () -> Unit ={}
    override fun onCleared() {
        super.onCleared()
        onClearedListener.invoke()
    }
}

For UseCase: I have defined two more functions, cancelJob() and monitorViewModelLifecycle(vm: BaseViewModel) and added another overloading function invoke(vm: BaseViewModel,params: Params,onResult: (Either<Failure, Type>) -> Unit = {}).

abstract class UseCase<out Type, in Params> where Type : Any {
    operator fun invoke(
        vm: BaseViewModel,
        params: Params,
        onResult: (Either<Failure, Type>) -> Unit = {}
    ) {
        monitorViewModelLifecycle(vm)
        uiScope.launch { onResult(withContext(Dispatchers.IO) { run(params) }) }
    }

    //Cancel the current ongoing job
    fun cancelJob(message: String = "Abort") {
        uiScope.cancel(message)
    }

    /**
     * Monitor the [BaseViewModel] lifecycle.
     * The motto is to auto clear any ongoing job that is tied to the [BaseViewModel].
     *
     * @param vm, [BaseViewModel] instance
     */
    fun monitorViewModelLifecycle(vm: BaseViewModel) {
        vm.onClearedListener = {
            cancelJob()
        }
    }
}

So, When the ViewModel.onClearedListener is invoked I'm cancelling the current Job.

Is there any better to way to acheive this?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

      pFad - Phonifier reborn

      Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

      Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


      Alternative Proxies:

      Alternative Proxy

      pFad Proxy

      pFad v3 Proxy

      pFad v4 Proxy