sync/io.github.maniramezan.kommon.sync/SyncResourceAdapter

SyncResourceAdapter

interface SyncResourceAdapter<E : SyncableEntity<E>, U, D, C>

Resource-specific glue for the generic loop in SyncEngine. Implement one of these (plus the wire DTO mapping) to make a new resource syncable — the contract logic (ack guard, pending guard, full-snapshot reconciliation, pagination drain, fullResyncRequired) lives in the engine, not here, so it holds identically for every resource.

Type Parameters

E

entity type (carries SyncableEntity bookkeeping)

U

upsert DTO, D delete DTO, C server-change DTO

Properties

abstract val resourceName: String

Functions

abstract suspend fun activeRows(): List<E>

Active (non-deleted) rows, for full-snapshot tombstone reconciliation.

abstract suspend fun api(request: SyncRequest<U, D>): SyncResponse<C>

abstract fun changeKey(change: C): String

abstract suspend fun findExisting(change: C): E?

isChangeDeleted

abstract fun isChangeDeleted(change: C): Boolean

abstract suspend fun pending(): List<E>

abstract suspend fun purgeSynced()

Drop clean synced rows for fullResyncRequired.

abstract suspend fun reload(entity: E): E?

Re-read the row for the ack guard (detects edits made during the in-flight request).

abstract fun syncKey(entity: E): String

Canonical business key; MUST equal the server's applied[].key and changeKey.

abstract fun toDelete(entity: E): D

abstract fun toEntity(change: C, existing: E?): E

abstract fun toUpsert(entity: E): U

abstract suspend fun upsert(entity: E)