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

package io.dico.parcels2.storage

import io.dico.parcels2.*
import kotlinx.coroutines.experimental.channels.SendChannel
import java.util.UUID

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 produceParcelData(channel: SendChannel<DataPair>, parcels: Sequence<ParcelId>)

    suspend fun produceAllParcelData(channel: SendChannel<DataPair>)

    suspend fun readParcelData(parcel: ParcelId): ParcelData?

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

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


    suspend fun setParcelData(parcel: ParcelId, data: ParcelData?)

    suspend fun setParcelOwner(parcel: ParcelId, owner: ParcelOwner?)

    suspend fun setLocalPlayerStatus(parcel: ParcelId, player: UUID, status: AddedStatus)

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

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


    suspend fun produceAllGlobalAddedData(channel: SendChannel<AddedDataPair<ParcelOwner>>)

    suspend fun readGlobalAddedData(owner: ParcelOwner): MutableAddedDataMap

    suspend fun setGlobalPlayerStatus(owner: ParcelOwner, player: UUID, status: AddedStatus)

}