Package me.aartikov.replica.common

Types

CombinedLoadingError

data class CombinedLoadingError(val exceptions: List<Exception>)

Represent several errors (one or more) occurred during a network request.

InvalidationMode

enum InvalidationMode : Enum<InvalidationMode>

Specifies how a replica behaves after invalidation.

LoadingError

data class LoadingError(val exception: Exception)

Represent an error occurred during a network request.

ObservingState

data class ObservingState( val observerIds: Set<Long> = emptySet(), val activeObserverIds: Set<Long> = emptySet(), val observingTime: ObservingTime = ObservingTime.Never)

Has information about observers of a replica.

ObservingStatus

enum ObservingStatus : Enum<ObservingStatus>

ObservingTime

interface ObservingTime : Comparable<ObservingTime>

Represent information when a replica was observed in last time.

OptimisticUpdate

fun interface OptimisticUpdate<T : Any>

Action executed for optimistic update

ReplicaId

@JvmInline

value class ReplicaId(val value: Long)

Unique identifier for a replica.

ReplicaTag

interface ReplicaTag

Can be used to perform bulk operations on a subset of replicas. See: cancelByTags, clearByTags, invalidateByTags.

Functions

applyAll

fun <T : Any> List<OptimisticUpdate<T>>.applyAll(data: T): T

performOptimisticUpdate

inline suspend fun <R> performOptimisticUpdate( begin: () -> Unit, commit: () -> Unit, crossinline rollback: suspend () -> Unit, noinline onSuccess: suspend () -> Unit? = null, noinline onError: suspend (Exception) -> Unit? = null, noinline onCanceled: suspend () -> Unit? = null, noinline onFinished: suspend () -> Unit? = null, block: () -> R): R

Executes begin and then block. If an operation succeed than commit is executed, otherwise rollback is executed. onSuccess, onError, onCanceled, onFinished are optional callbacks for additional actions.