kvision-common-remote/io.kvision.remote

Package-level declarations

A set of components for creating multiplatform automatic JSON-RPC connectivity with a backend server.

Types

AbstractServiceException

@Serializable

abstract class AbstractServiceException : Exception

CallAgent

open class CallAgent

An agent responsible for remote calls.

ContentTypeException

class ContentTypeException(message: String) : Exception

An exception thrown when the server returns a non-json response for a json-rpc call.

Credentials

@Serializable

data class Credentials(val username: String? = null, val password: String? = null)

Username and password credentials.

HttpMethod

enum HttpMethod : Enum<HttpMethod>

IllegalParameterCountException

class IllegalParameterCountException(val actualParameterCount: Int, val expectedParamterCount: Int) : RuntimeException

JsonRpcRequest

@Serializable

data class JsonRpcRequest(val id: Int, val method: String, val params: List<String?>, val jsonrpc: String = "2.0")

JsonRpcResponse

@Serializable

data class JsonRpcResponse(val id: Int? = null, val result: String? = null, val error: String? = null, val exceptionType: String? = null, val exceptionJson: String? = null, val jsonrpc: String = "2.0")

KVRemoteAgent

open class KVRemoteAgent<T : Any>(val serviceManager: KVServiceMgr<T>, serializersModules: List<SerializersModule>? = null, val requestFilter: suspend RequestInit.() -> Unit? = null)

Client side agent for JSON-RPC remote calls.

KVServiceBinder

abstract class KVServiceBinder<out T, RH, WH, SH>(routeNameGenerator: NameGenerator? = null)

Binds HTTP calls to kotlin functions

KVServiceManagerJs

open class KVServiceManagerJs<out T : Any> : KVServiceMgr<T>

KVServiceMgr

interface KVServiceMgr<out T : Any>

Base interface for fullstack service manager.

LoginService

class LoginService(val loginEndpoint: String)

Form login dispatcher.

NameGenerator

typealias NameGenerator = () -> String

Object

external class Object

JavaScript Object type

ObjectDeSerializer

interface ObjectDeSerializer

RemoteData

@Serializable

data class RemoteData<T>(val data: List<T> = listOf(), val last_page: Int = 0, val last_row: Int? = null)

RemoteFilter

@Serializable

data class RemoteFilter(val field: String, val type: String, val value: String?)

RemoteOption

@Serializable

data class RemoteOption(val value: String? = null, val text: String? = null, val className: String? = null, val subtext: String? = null, val icon: String? = null, val content: String? = null, val disabled: Boolean = false, val divider: Boolean = false)

RemoteSerialization

expect object RemoteSerialization

JSON utility functions

actual object RemoteSerialization

JSON utility functions

actual object RemoteSerialization

JSON utility functions

RemoteSorter

@Serializable

data class RemoteSorter(val field: String, val dir: String)

ResponseBodyType

enum ResponseBodyType : Enum<ResponseBodyType>

HTTP response body types.

ResultSerializer

class ResultSerializer<T>(tSerializer: KSerializer<T>) : KSerializer<Result<T>>

A custom serializer for the Result class.

RouteMapEntry

data class RouteMapEntry<T>(val method: HttpMethod, val path: String, val handler: T)

RouteMapRegistry

interface RouteMapRegistry<T>

Stores a mapping from an HTTP-method+path to a handler

SecurityException

class SecurityException(message: String) : Exception

A security exception.

SecurityMgr

abstract class SecurityMgr

Form login dispatcher.

ServiceException

class ServiceException(message: String) : Exception

SimpleRemoteOption

@Serializable

data class SimpleRemoteOption(val value: String, val text: String? = null)

Socket

class Socket

A websocket client implementation.

SocketClosedException

class SocketClosedException(val reason: String) : Throwable

Websocket closed exception class.

Properties

HTTP_UNAUTHORIZED

const val HTTP_UNAUTHORIZED: Int = 401

HTTP status unauthorized (401).

Functions

createNameGenerator

fun createNameGenerator(prefix: String): NameGenerator

createRouteMapRegistry

fun <T> createRouteMapRegistry(): RouteMapRegistry<T>

Create a default implementation of @see RouteMapRegistry

deserialize

inline fun <T> ObjectDeSerializer.deserialize(str: String?): T

encodeURIComponent

external fun encodeURIComponent(uri: String): String

JavaScript encodeURIComponent function

getService

inline fun <T : Any> getService(serializersModules: List<SerializersModule>? = null, noinline requestFilter: suspend RequestInit.() -> Unit? = null): T

This will make IntelliJ think that this function exists. The real implementation will be generated by the KVision Gradle Plugin.

getWebSocketUrl

fun getWebSocketUrl(url: String): String

Creates a websocket URL from current window.location and given path.

handleSseConnection

suspend fun <T, OBJECTS_OUT> handleSseConnection(deSerializer: ObjectDeSerializer, rawOut: SendChannel<String>, serializerOut: KSerializer<OBJECTS_OUT>, service: T, function: suspend T.(SendChannel<OBJECTS_OUT>) -> Unit)

Convenience function for cases were the raw channel works with strings. See the overloaded method for details.

suspend fun <T, RAW_OUT, OBJECTS_OUT> handleSseConnection(deSerializer: ObjectDeSerializer, rawOut: SendChannel<RAW_OUT>, rawOutFromText: (String) -> RAW_OUT, serializerOut: KSerializer<OBJECTS_OUT>, service: T, function: suspend T.(SendChannel<OBJECTS_OUT>) -> Unit)

function receives a SendChannel, from which objects are read, serialized and sent to the client in the form of JSON-RPC calls.

handleWebsocketConnection

suspend fun <T, OBJECTS_IN, OBJECTS_OUT> handleWebsocketConnection(deSerializer: ObjectDeSerializer, rawIn: ReceiveChannel<String>, rawOut: SendChannel<String>, serializerIn: KSerializer<OBJECTS_IN>, serializerOut: KSerializer<OBJECTS_OUT>, service: T, function: suspend T.(ReceiveChannel<OBJECTS_IN>, SendChannel<OBJECTS_OUT>) -> Unit)

Convenience function for cases were the raw channels work with strings. See the overloaded method for details.

suspend fun <T, RAW_IN, RAW_OUT, OBJECTS_IN, OBJECTS_OUT> handleWebsocketConnection(deSerializer: ObjectDeSerializer, rawIn: ReceiveChannel<RAW_IN>, rawInToText: (RAW_IN) -> String?, rawOut: SendChannel<RAW_OUT>, rawOutFromText: (String) -> RAW_OUT, serializerIn: KSerializer<OBJECTS_IN>, serializerOut: KSerializer<OBJECTS_OUT>, service: T, function: suspend T.(ReceiveChannel<OBJECTS_IN>, SendChannel<OBJECTS_OUT>) -> Unit)

Reads JSON-RPC calls from rawIn, deserializes them and forwards them in form of a channel to function. Additionally function also receives a SendChannel, from which objects are read, serialized and sent to the client in the form of JSON-RPC calls.

kotlinxObjectDeSerializer

fun kotlinxObjectDeSerializer(serializersModules: List<SerializersModule>? = null): ObjectDeSerializer

obj

fun obj(init: dynamic.() -> Unit): dynamic

Helper function for creating JavaScript objects.

requireParameterCountEqualTo

fun requireParameterCountEqualTo(actualParameterCount: Int, expectedParamterCount: Int)

fun requireParameterCountEqualTo(params: Collection<*>, expectedParameterCount: Int)

serializeNonNull

inline fun <T> ObjectDeSerializer.serializeNonNull(obj: T): String

serializeNullable

inline fun <T> ObjectDeSerializer.serializeNullable(obj: T?): String?