equinox-compose/com.tecknobit.equinoxcompose.session/Retriever

Retriever

class Retriever(val retrieverScope: CoroutineScope)

The Retriever handles that repetitive retrieving routines and execute them in background by the retrieverScope

Author

N7ghtm4r3 - Tecknobit

Parameters

retrieverScope

The coroutine used to execute the retrieving routines

Constructors

Retriever

constructor(retrieverScope: CoroutineScope)

Types

Companion

object Companion

RetrieverWrapper

interface RetrieverWrapper

The RetrieverWrapper interface is useful for wrapping and facilitating operation with the Retriever, so the inheriting classes will invoke just the wrapper methods for a clean readability of the code, for example:

RetrievingRoutine

private data class RetrievingRoutine( val currentContext: KClass<*>, val routine: suspend () -> Unit, val repeatRoutine: Boolean = true, val refreshDelay: Long = 1000)

The RetrievingRoutine data class is useful to memorize the last routine executed by the execute method

Properties

isRefreshing

private var isRefreshing: Boolean

isRefreshing whether the retrieverScope is already refreshing

lastRoutineExecuted

private lateinit var lastRoutineExecuted: Retriever.RetrievingRoutine

lastRoutineExecuted the last routine executed by the execute method must re-launched after the suspend method has been invoked

retrieverScope

private val retrieverScope: CoroutineScope

Functions

canStart

fun canStart(): Boolean

Method used to get whether the retrieverScope can start, so if there aren't other jobs that routine is already executing

continueToRetrieve

fun continueToRetrieve(currentContext: KClass<*>): Boolean

Method used to check if the retrieverScope can continue to refresh or need to be stopped, this for example when the UI displayed changes and the requests to refresh the UI data also changes

execute

fun execute(currentContext: KClass<*>, routine: suspend () -> Unit, repeatRoutine: Boolean = true, refreshDelay: Long = 1000)

Method used to execute the refresh routine designed

restart

fun restart()

Method used to restart the current retrieverScope after other requests has been executed, the isRefreshing instance will be set as true to deny the restart of the routine after executing the other requests

suspend

fun suspend()

Method used to suspend the current retrieverScope to execute other requests to the backend, the isRefreshing instance will be set as false to allow the restart of the routine after executing the other requests