src/main/kotlin/io/dico/parcels2/storage/Backing.kt


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51

package io.dico.parcels2.storage

import io.dico.parcels2.AddedData
import io.dico.parcels2.Parcel
import io.dico.parcels2.ParcelData
import io.dico.parcels2.ParcelOwner
import kotlinx.coroutines.experimental.channels.ProducerScope
import java.util.*

interface Backing {

    val name: String

    val isConnected: Boolean

    suspend fun init()

    suspend fun shutdown()


    /**
     * This producer function is capable of constantly reading parcels from a potentially infinite sequence,
     * and provide parcel data for it as read from the database.
     */
    suspend fun ProducerScope<Pair<Parcel, ParcelData?>>.produceParcelData(parcels: Sequence<Parcel>)

    suspend fun ProducerScope<Pair<SerializableParcel, ParcelData?>>.produceAllParcelData()

    suspend fun readParcelData(parcelFor: Parcel): ParcelData?

    suspend fun getOwnedParcels(user: ParcelOwner): List<SerializableParcel>

    suspend fun getNumParcels(user: ParcelOwner): Int = getOwnedParcels(user).size


    suspend fun setParcelData(parcelFor: Parcel, data: ParcelData?)

    suspend fun setParcelOwner(parcelFor: Parcel, owner: ParcelOwner?)

    suspend fun setParcelPlayerState(parcelFor: Parcel, player: UUID, state: Boolean?)

    suspend fun setParcelAllowsInteractInventory(parcel: Parcel, value: Boolean)

    suspend fun setParcelAllowsInteractInputs(parcel: Parcel, value: Boolean)


    suspend fun readGlobalPlayerStateData(owner: ParcelOwner): AddedData?

    suspend fun setGlobalPlayerState(owner: ParcelOwner, player: UUID, state: Boolean?)

}