ksrpc-core/com.monkopedia.ksrpc

Package-level declarations

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

Types

abstract class BaseSubserviceTransformer<T : RpcService, O> : Transformer<O>

Shared abstract base for transformers whose wire representation is a sub-service reference (a channel id registered on the host, resolved to a client stub on the peer). The base holds the register / lookup machinery operating on the service-facing type T; concrete subclasses adapt a (possibly different) user-facing type O to T via toService / fromService.

BinaryDataTransformer

interface BinaryDataTransformer

Marker for transformers whose wire representation is CallData.Binary / RpcBinaryData, regardless of the user-facing type they adapt. Consumers (e.g. introspection, diagnostics) should treat any implementor as "binary payload" rather than enumerating individual adapter objects.

BinaryTransformer

object BinaryTransformer : Transformer<RpcBinaryData> , BinaryDataTransformer

CallDataSerializer

interface CallDataSerializer<T>

ErrorListener

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

class KsrpcEnvironmentBuilder<T> : KsrpcEnvironment<T>

KsrpcException

open class KsrpcException(val code: Int, val message: String, val data: Any? = null, cause: Throwable? = null) : RuntimeException

Base class for exceptions thrown by the ksrpc runtime.

Logger

interface Logger

MetadataValue

sealed class MetadataValue

A typed wrapper for an argument captured into a MethodMetadata.

MethodMetadata

data class MethodMetadata(val annotationFqName: String, val arguments: List<Pair<String, MetadataValue>>)

A captured sibling annotation on a @KsMethod function.

RpcEndpointException

open class RpcEndpointException(str: String) : KsrpcException

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

RpcException

class RpcException(message: String) : KsrpcException

Wrapper around exceptions thrown in remote calls.

RpcMethod

class RpcMethod<T : RpcService, I, O>(val endpoint: String, val inputTransform: Transformer<I>, val outputTransform: Transformer<O>, method: ServiceExecutor, val metadata: List<MethodMetadata>)

A wrapper around calling into or from stubs/serialization.

RpcObject

interface RpcObject<T : RpcService>

Interface for generated companions of RpcService.

RpcObjectFactory

interface RpcObjectFactory<T : RpcService>

Supertype of the generated companion for generic @KsService interfaces. Lets callers materialize an RpcObject for a concrete instantiation of the service when they only have KTypes (for example, reflective/introspection code or sub-service transformers).

RpcObjectKey

@Target(allowedTargets = [AnnotationTarget.CLASS])

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

@Target(allowedTargets = [AnnotationTarget.CLASS])

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

Used to find RpcObject of services in js implementations.

@Target(allowedTargets = [AnnotationTarget.CLASS])

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

@Target(allowedTargets = [AnnotationTarget.CLASS])

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

Used to find RpcObject of services in native implementations.

@Target(allowedTargets = [AnnotationTarget.CLASS])

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

Used to find RpcObject of services in js implementations.

SerializerTransformer

class SerializerTransformer<I>(val serializer: KSerializer<I>) : Transformer<I>

SubserviceTransformer

class SubserviceTransformer<T : RpcService>(val serviceObject: RpcObject<T>) : BaseSubserviceTransformer<T, T>

SuspendCloseableObservable

interface SuspendCloseableObservable : SuspendCloseable

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

Transformer

interface Transformer<T>

UnhandledMethodHandler

interface UnhandledMethodHandler

Opt-in fallback for services that want to handle incoming RPC calls targeting method names that are not registered on the service.

Properties

asString

expect val Throwable.asString: String

actual val Throwable.asString: String

timeoutMillis

val RpcMethod<*, *, *>.timeoutMillis: Long?

Returns the timeout in milliseconds configured via @KsTimeout on the source method, or null if no timeout annotation was present.

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>

onError

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

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

reconfigure

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.

resolveSerializerOrThrow

fun resolveSerializerOrThrow(type: KType, serviceName: String): KSerializer<Any?>

Resolve a KSerializer for type via kotlinx.serialization.serializer, converting any SerializationException into an IllegalArgumentException that names the offending service and type. Used by generated RpcObjectFactory.create bodies.

rpcObject

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

Helper to get RpcObject for a given RpcService

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

Resolve the RpcObject for T.

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

serialized

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.

toException

fun RpcFailure.toException(): RpcException

Build an RpcException carrying the stack captured in this RpcFailure.

toStub

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

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

use

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

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