ksrpc-core/com.monkopedia.ksrpc/RpcObject

RpcObject

Interface for generated companions of RpcService.

Samples

// Define a service interface with @KsService and @KsMethod annotations.
// The compiler plugin generates a companion RpcObject and stub automatically.
val rpcObj = rpcObject<GreetingService>()
val endpoint = rpcObj.findEndpoint("greet")

Properties

endpoints

abstract val endpoints: List<String>

serviceName

abstract val serviceName: String

serviceTier

open val serviceTier: ServiceTier

The minimum transport capability tier this service requires, as determined by the compiler plugin from the service's method signatures. Used by transport registration checks to reject services that can't work on a given channel.

Functions

createStub

abstract fun <S> createStub(channel: SerializedService<S>): T

findEndpoint

abstract fun findEndpoint(endpoint: String): RpcMethod<*, *, *>