kvision-common-remote/io.kvision.remote

Package io.kvision.remote

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

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

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

Types

CallAgent

open class CallAgent

An agent responsible for remote calls.

Credentials

data class Credentials(username: String?, password: String?)

Username and password credentials.

HttpMethod

enum HttpMethod : Enum<HttpMethod>

IllegalParameterCountException

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

JSON

object JSON

JSON utility functions

JsonRpcRequest

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

JsonRpcResponse

data class JsonRpcResponse(id: Int?, result: String?, error: String?, exceptionType: String?, jsonrpc: String)

KVRemoteAgent

open class KVRemoteAgent<T : Any>(serviceManager: <ERROR CLASS><T>, requestFilter: <ERROR CLASS>.() -> Unit?) : RemoteAgent

Client side agent for JSON-RPC remote calls.

KVServiceBinder

abstract class KVServiceBinder<T, RH, WH>(deSerializer: ObjectDeSerializer, routeNameGenerator: NameGenerator?)

Binds HTTP calls to kotlin functions

KVServiceManagerJs

open class KVServiceManagerJs<T : Any>

KVServiceMgr

interface KVServiceMgr<T : Any>

Base interface for fullstack service manager.

LoginService

class LoginService(loginEndpoint: String)

Form login dispatcher.

NameGenerator

typealias NameGenerator = () -> String

NotEnumTypeException

class NotEnumTypeException

NotStandardTypeException

class NotStandardTypeException(type: String)

Object

external class Object

JavaScript Object type

ObjectDeSerializer

interface ObjectDeSerializer

RemoteAgent

open class RemoteAgent

Interface for client side agent for JSON-RPC remote calls.

RemoteData

data class RemoteData<T>(data: List<T>, last_page: Int)

RemoteFilter

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

RemoteOption

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

RemoteSorter

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

ResponseBodyType

enum ResponseBodyType : Enum<ResponseBodyType>

HTTP response body types.

RouteMapEntry

data class RouteMapEntry<T>(method: <ERROR CLASS>, path: String, handler: T)

RouteMapRegistry

interface RouteMapRegistry<T>

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

SecurityException

class SecurityException(message: String)

A security exception.

SecurityMgr

abstract class SecurityMgr

Form login dispatcher.

ServiceException

class ServiceException(message: String)

SimpleRemoteOption

data class SimpleRemoteOption(value: String, text: String?)

Socket

class Socket

A websocket client implementation.

SocketClosedException

class SocketClosedException(reason: String) : Throwable

Websocket closed exception class.

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

getWebSocketUrl

fun getWebSocketUrl(url: String): String

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

handleWebsocketConnection

suspend fun <T, OBJECTS_IN, OBJECTS_OUT> handleWebsocketConnection(deSerializer: ObjectDeSerializer, rawIn: <ERROR CLASS><String>, rawOut: <ERROR CLASS><String>, serializerIn: <ERROR CLASS><OBJECTS_IN>, serializerOut: <ERROR CLASS><OBJECTS_OUT>, service: T, function: suspend T.(<ERROR CLASS><OBJECTS_IN>, <ERROR CLASS><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: <ERROR CLASS><RAW_IN>, rawInToText: (RAW_IN) -> String?, rawOut: <ERROR CLASS><RAW_OUT>, rawOutFromText: (String) -> RAW_OUT, serializerIn: <ERROR CLASS><OBJECTS_IN>, serializerOut: <ERROR CLASS><OBJECTS_OUT>, service: T, function: suspend T.(<ERROR CLASS><OBJECTS_IN>, <ERROR CLASS><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(): 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?

Properties

HTTP_UNAUTHORIZED

const val HTTP_UNAUTHORIZED: Int = 401

HTTP status unauthorized (401).

kvSerializersModule

val kvSerializersModule: <ERROR CLASS>