Mokksy/dev.mokksy.mokksy.jsonrpc

Package-level declarations

Types

JSONRPCError

@Serializable

data class JSONRPCError<out D>(val code: Int, val message: String, val data: D? = null)

Represents a JSON-RPC 2.0 error object.

JSONRPCErrorBuilder

class JSONRPCErrorBuilder<D>

DSL builder for constructing JSONRPCError instances.

JSONRPCMessage

@Serializable(with = JSONRPCMessageSerializer::class)

sealed class JSONRPCMessage<out P>

Base type for JSON-RPC 2.0 messages sent from client to server.

JSONRPCMessageSerializer

class JSONRPCMessageSerializer(paramsSerializer: KSerializer) : KSerializer<JSONRPCMessage>

Content-based polymorphic serializer for JSONRPCMessage.

JSONRPCNotification

@Serializable

data class JSONRPCNotification<out P>(val method: String, val params: P? = null) : JSONRPCMessage

A JSON-RPC 2.0 notification — a request without an id field.

JSONRPCRequest

@Serializable

data class JSONRPCRequest<out P>(val id: RequestId?, val method: String, val params: P? = null) : JSONRPCMessage

A JSON-RPC 2.0 request that expects a response from the server.

JSONRPCResponse

@Serializable(with = JSONRPCResponseSerializer::class)

sealed class JSONRPCResponse<out T, out E>

Represents a JSON-RPC 2.0 response.

JSONRPCResponseBuilder

class JSONRPCResponseBuilder<T, E>

DSL builder for constructing JSONRPCResponse instances.

JSONRPCResponseSerializer

class JSONRPCResponseSerializer<T, E>(resultSerializer: KSerializer<T>, errorDataSerializer: KSerializer<E>) : KSerializer<JSONRPCResponse<T, E>>

Content-based polymorphic serializer for JSONRPCResponse.

NullableRequestIdSerializer

object NullableRequestIdSerializer : KSerializer<RequestId?>

Serializer for nullable RequestId?.

RequestId

@Serializable(with = RequestIdSerializer::class)

sealed interface RequestId

Represents a JSON-RPC 2.0 request identifier.

RequestIdSerializer

object RequestIdSerializer : KSerializer<RequestId>

Serializer for non-nullable RequestId.

UntypedJSONRPCResponse

typealias UntypedJSONRPCResponse = JSONRPCResponse<JsonElement, JsonElement>

A JSONRPCResponse with untyped result and error data, deserialized as raw JsonElement.

Functions

jsonRPCError

inline fun <D> jsonRPCError(init: JSONRPCErrorBuilder<D>.() -> Unit): JSONRPCError<D>

Creates a JSONRPCError using the DSL builder.

jsonRPCResponse

inline fun <T, E> jsonRPCResponse(init: JSONRPCResponseBuilder<T, E>.() -> Unit): JSONRPCResponse<T, E>

Creates a JSONRPCResponse using the DSL builder.

@JvmName(name = "jsonRPCResponseResult")

inline fun <T> jsonRPCResponse(init: JSONRPCResponseBuilder<T, Nothing>.() -> Unit): JSONRPCResponse<T, Nothing>

Creates a JSONRPCResponse using the DSL builder, with error data type defaulting to Nothing.

RequestId

fun RequestId(value: Int): RequestId

Creates a RequestId from an Int value.

fun RequestId(value: Long): RequestId

Creates a RequestId from a Long value.

fun RequestId(value: String): RequestId

Creates a RequestId from a String value.