ksrpc-core/com.monkopedia.ksrpc

Package-level declarations

Contains Core definitions of for configuring and constructing ksrpc services and stubs.

Contains Core definitions of for configuring and constructing ksrpc services and stubs.

Contains Core definitions of for configuring and constructing ksrpc services and stubs.

Contains Core definitions of for configuring and constructing ksrpc services and stubs.

Types

CallDataSerializer

interface CallDataSerializer<T>

fun interface ErrorListener

Interface used for handling any errors that occur during hosting.

KsrpcEnvironment

interface KsrpcEnvironment<T>

Global configuration for KSRPC channels and services.

KsrpcEnvironmentBuilder

data class KsrpcEnvironmentBuilder<T> : KsrpcEnvironment<T>

interface Logger

RpcEndpointException

class RpcEndpointException(str: String) : IllegalArgumentException

Thrown when an endpoint cannot be found. Could happen from version mismatch or other programmer errors.

class RpcMethod<T : RpcService, I, O>

A wrapper around calling into or from stubs/serialization.

interface RpcObject<T : RpcService>

Interface for generated companions of RpcService.

annotation class RpcObjectKey(val rpcObject: KClass<out RpcObject<*>>)

Used to find RpcObject of services in js implementations.

annotation class RpcObjectKey(val rpcObject: KClass<out RpcObject<*>>)

Used to find RpcObject of services in native implementations.

SuspendCloseableObservable

interface SuspendCloseableObservable : SuspendCloseable

Used for implementations of SuspendCloseable that need observers attached to be notified when SuspendCloseable.close is called.

Properties

expect val Throwable.asString: String

actual val Throwable.asString: String

actual val Throwable.asString: String

actual val Throwable.asString: String

const val ERROR_PREFIX: String

Functions

ksrpcEnvironment

fun <T> ksrpcEnvironment(serializer: CallDataSerializer<T>, builder: KsrpcEnvironmentBuilder<T>.() -> Unit): KsrpcEnvironment<T>

fun ksrpcEnvironment(stringFormat: StringFormat = Json, builder: KsrpcEnvironmentBuilder<String>.() -> Unit): KsrpcEnvironment<String>

fun <T> KsrpcEnvironment<T>.onError(listener: ErrorListener): KsrpcEnvironment<T>

Convenience method for easily creating a copy of KsrpcEnvironment with a local error listener.

fun <T> KsrpcEnvironment<T>.reconfigure(builder: KsrpcEnvironmentBuilder<T>.() -> Unit): KsrpcEnvironment<T>

Creates a copy of the KsrpcEnvironment provided and allows changes to it before returning it. This method does NOT modify the original KsrpcEnvironment.

expect inline fun <T : RpcService> rpcObject(): RpcObject<T>

Helper to get RpcObject for a given RpcService

actual inline fun <T : RpcService> rpcObject(): RpcObject<T>

actual inline fun <T : RpcService> rpcObject(): RpcObject<T>

actual inline fun <T : RpcService> rpcObject(): RpcObject<T>

inline fun <T : RpcService, S> T.serialized(env: KsrpcEnvironment<S>): SerializedService<S>

fun <T : RpcService, S> T.serialized(rpcObject: RpcObject<T>, env: KsrpcEnvironment<S>): SerializedService<S>

Convert a T into a SerializedService for hosting.

inline fun <T : RpcService, S> SerializedService<S>.toStub(): T

Convert a SerializedService to a T for use as a client.

inline suspend fun <T : SuspendCloseable, R> T.use(usage: (T) -> R): R

Helper that runs usage then invokes SuspendCloseable.close in the finally block.