commonMain.org.brightify.hyperdrive.krpc.application.RPCNodeExtension.kt Maven / Gradle / Ivy

Go to download
package org.brightify.hyperdrive.krpc.application

import org.brightify.hyperdrive.krpc.RPCTransport
import org.brightify.hyperdrive.krpc.description.ServiceDescription
import org.brightify.hyperdrive.krpc.protocol.RPCIncomingInterceptor
import org.brightify.hyperdrive.krpc.protocol.RPCOutgoingInterceptor
import kotlin.coroutines.CoroutineContext
import kotlin.reflect.KClass

interface RPCNodeExtension: RPCIncomingInterceptor, RPCOutgoingInterceptor {
    interface Identifier {
        val uniqueIdentifier: String
        val extensionClass: KClass
    }

    val providedServices: List
        get() = emptyList()

    /**
     * Binds an extension to a transport. The provided transport is already intercepted by all registered extensions including this one.
     * The extension is allowed to store parts of the contract or the whole contract.
     */
    suspend fun bind(transport: RPCTransport, contract: RPCNode.Contract)

    suspend fun enhanceParallelWorkContext(context: CoroutineContext): CoroutineContext = context

    suspend fun whileConnected() { }

    interface Factory {
        /**
         * Identifier of the RPC extension. It's required to always be unique.
         */
        val identifier: Identifier

        /**
         * Whether the extension should only be created when it's available both locally and remotely.
         */
        val isRequiredOnOtherSide: Boolean

        fun create(): E
    }
}