From a81c549e277d1a07e87cf8e2eecf89662deda323 Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Sun, 23 Dec 2018 01:32:27 +0100 Subject: API documentation for KVision 0.0.22 --- .../-k-v-service-manager/-init-.html | 15 ++ .../-k-v-service-manager/-l-o-g.html | 14 ++ .../-k-v-service-manager/add-route.html | 14 ++ .../-k-v-service-manager/apply-routes.html | 16 ++ .../-k-v-service-manager/bind.html | 38 +++++ .../-k-v-service-manager/call.html | 14 ++ .../-k-v-service-manager/calls.html | 14 ++ .../-k-v-service-manager/counter.html | 14 ++ .../-k-v-service-manager/delete-requests.html | 14 ++ .../-k-v-service-manager/get-calls.html | 15 ++ .../-k-v-service-manager/get-parameter.html | 14 ++ .../-k-v-service-manager/index.html | 169 +++++++++++++++++++++ .../-k-v-service-manager/mapper.html | 14 ++ .../-k-v-service-manager/options-requests.html | 14 ++ .../-k-v-service-manager/post-requests.html | 14 ++ .../-k-v-service-manager/put-requests.html | 14 ++ .../-k-v-service-manager/routes.html | 14 ++ .../-k-v-service-manager/service-class.html | 14 ++ 18 files changed, 435 insertions(+) create mode 100644 api/pl.treksoft.kvision.remote/-k-v-service-manager/-init-.html create mode 100644 api/pl.treksoft.kvision.remote/-k-v-service-manager/-l-o-g.html create mode 100644 api/pl.treksoft.kvision.remote/-k-v-service-manager/add-route.html create mode 100644 api/pl.treksoft.kvision.remote/-k-v-service-manager/apply-routes.html create mode 100644 api/pl.treksoft.kvision.remote/-k-v-service-manager/bind.html create mode 100644 api/pl.treksoft.kvision.remote/-k-v-service-manager/call.html create mode 100644 api/pl.treksoft.kvision.remote/-k-v-service-manager/calls.html create mode 100644 api/pl.treksoft.kvision.remote/-k-v-service-manager/counter.html create mode 100644 api/pl.treksoft.kvision.remote/-k-v-service-manager/delete-requests.html create mode 100644 api/pl.treksoft.kvision.remote/-k-v-service-manager/get-calls.html create mode 100644 api/pl.treksoft.kvision.remote/-k-v-service-manager/get-parameter.html create mode 100644 api/pl.treksoft.kvision.remote/-k-v-service-manager/index.html create mode 100644 api/pl.treksoft.kvision.remote/-k-v-service-manager/mapper.html create mode 100644 api/pl.treksoft.kvision.remote/-k-v-service-manager/options-requests.html create mode 100644 api/pl.treksoft.kvision.remote/-k-v-service-manager/post-requests.html create mode 100644 api/pl.treksoft.kvision.remote/-k-v-service-manager/put-requests.html create mode 100644 api/pl.treksoft.kvision.remote/-k-v-service-manager/routes.html create mode 100644 api/pl.treksoft.kvision.remote/-k-v-service-manager/service-class.html (limited to 'api/pl.treksoft.kvision.remote/-k-v-service-manager') diff --git a/api/pl.treksoft.kvision.remote/-k-v-service-manager/-init-.html b/api/pl.treksoft.kvision.remote/-k-v-service-manager/-init-.html new file mode 100644 index 00000000..f011779c --- /dev/null +++ b/api/pl.treksoft.kvision.remote/-k-v-service-manager/-init-.html @@ -0,0 +1,15 @@ + + + +KVServiceManager.<init> - kvision + + + +kvision / pl.treksoft.kvision.remote / KVServiceManager / <init>
+
+

<init>

+ +KVServiceManager(serviceClass: KClass<T>) +

Multiplatform service manager.

+ + diff --git a/api/pl.treksoft.kvision.remote/-k-v-service-manager/-l-o-g.html b/api/pl.treksoft.kvision.remote/-k-v-service-manager/-l-o-g.html new file mode 100644 index 00000000..aa3cd070 --- /dev/null +++ b/api/pl.treksoft.kvision.remote/-k-v-service-manager/-l-o-g.html @@ -0,0 +1,14 @@ + + + +KVServiceManager.LOG - kvision + + + +kvision / pl.treksoft.kvision.remote / KVServiceManager / LOG
+
+

LOG

+ +val LOG: <ERROR CLASS> + + diff --git a/api/pl.treksoft.kvision.remote/-k-v-service-manager/add-route.html b/api/pl.treksoft.kvision.remote/-k-v-service-manager/add-route.html new file mode 100644 index 00000000..fe7b0ff8 --- /dev/null +++ b/api/pl.treksoft.kvision.remote/-k-v-service-manager/add-route.html @@ -0,0 +1,14 @@ + + + +KVServiceManager.addRoute - kvision + + + +kvision / pl.treksoft.kvision.remote / KVServiceManager / addRoute
+
+

addRoute

+ +fun addRoute(method: RpcHttpMethod, path: String, handler: (Request, <ERROR CLASS>) -> Unit): Unit + + diff --git a/api/pl.treksoft.kvision.remote/-k-v-service-manager/apply-routes.html b/api/pl.treksoft.kvision.remote/-k-v-service-manager/apply-routes.html new file mode 100644 index 00000000..96e7e799 --- /dev/null +++ b/api/pl.treksoft.kvision.remote/-k-v-service-manager/apply-routes.html @@ -0,0 +1,16 @@ + + + +KVServiceManager.applyRoutes - kvision + + + +kvision / pl.treksoft.kvision.remote / KVServiceManager / applyRoutes
+
+

applyRoutes

+ +actual fun applyRoutes(k: KVServer): Unit +

Applies all defined routes to the given server. +Not used on the js platform.

+ + diff --git a/api/pl.treksoft.kvision.remote/-k-v-service-manager/bind.html b/api/pl.treksoft.kvision.remote/-k-v-service-manager/bind.html new file mode 100644 index 00000000..cd647656 --- /dev/null +++ b/api/pl.treksoft.kvision.remote/-k-v-service-manager/bind.html @@ -0,0 +1,38 @@ + + + +KVServiceManager.bind - kvision + + + +kvision / pl.treksoft.kvision.remote / KVServiceManager / bind
+
+

bind

+ +

protected inline actual fun <reified RET> bind(noinline function: suspend T.() -> RET, route: String?, method: RpcHttpMethod): Unit

+ +

protected inline actual fun <reified PAR, reified RET> bind(noinline function: suspend T.(PAR) -> RET, route: String?, method: RpcHttpMethod): Unit

+ +

protected inline actual fun <reified PAR1, reified PAR2, reified RET> bind(noinline function: suspend T.(PAR1, PAR2) -> RET, route: String?, method: RpcHttpMethod): Unit

+ +

protected inline actual fun <reified PAR1, reified PAR2, reified PAR3, reified RET> bind(noinline function: suspend T.(PAR1, PAR2, PAR3) -> RET, route: String?, method: RpcHttpMethod): Unit

+ +

protected inline actual fun <reified PAR1, reified PAR2, reified PAR3, reified PAR4, reified RET> bind(noinline function: suspend T.(PAR1, PAR2, PAR3, PAR4) -> RET, route: String?, method: RpcHttpMethod): Unit

+ +

protected inline actual fun <reified PAR1, reified PAR2, reified PAR3, reified PAR4, reified PAR5, reified RET> bind(noinline function: suspend T.(PAR1, PAR2, PAR3, PAR4, PAR5) -> RET, route: String?, method: RpcHttpMethod): Unit

Binds a given route with a function of the receiver.

Parameters

+function - a function of the receiver

+route - a route

+method - a HTTP method

+ +protected actual fun bind(function: T.(String?, String?) -> List<<ERROR CLASS>>): Unit +

Binds a given function of the receiver as a select options source

Parameters

+function - a function of the receiver

+ + diff --git a/api/pl.treksoft.kvision.remote/-k-v-service-manager/call.html b/api/pl.treksoft.kvision.remote/-k-v-service-manager/call.html new file mode 100644 index 00000000..c241f29f --- /dev/null +++ b/api/pl.treksoft.kvision.remote/-k-v-service-manager/call.html @@ -0,0 +1,14 @@ + + + +KVServiceManager.call - kvision + + + +kvision / pl.treksoft.kvision.remote / KVServiceManager / call
+
+

call

+ +fun call(method: RpcHttpMethod, path: String, handler: (Request, <ERROR CLASS>) -> Unit): KVServer.() -> Unit + + diff --git a/api/pl.treksoft.kvision.remote/-k-v-service-manager/calls.html b/api/pl.treksoft.kvision.remote/-k-v-service-manager/calls.html new file mode 100644 index 00000000..79c1a020 --- /dev/null +++ b/api/pl.treksoft.kvision.remote/-k-v-service-manager/calls.html @@ -0,0 +1,14 @@ + + + +KVServiceManager.calls - kvision + + + +kvision / pl.treksoft.kvision.remote / KVServiceManager / calls
+
+

calls

+ +protected val calls: MutableMap<String, Pair<String, RpcHttpMethod>> + + diff --git a/api/pl.treksoft.kvision.remote/-k-v-service-manager/counter.html b/api/pl.treksoft.kvision.remote/-k-v-service-manager/counter.html new file mode 100644 index 00000000..54c3d28a --- /dev/null +++ b/api/pl.treksoft.kvision.remote/-k-v-service-manager/counter.html @@ -0,0 +1,14 @@ + + + +KVServiceManager.counter - kvision + + + +kvision / pl.treksoft.kvision.remote / KVServiceManager / counter
+
+

counter

+ +var counter: Int + + diff --git a/api/pl.treksoft.kvision.remote/-k-v-service-manager/delete-requests.html b/api/pl.treksoft.kvision.remote/-k-v-service-manager/delete-requests.html new file mode 100644 index 00000000..efd6e9fa --- /dev/null +++ b/api/pl.treksoft.kvision.remote/-k-v-service-manager/delete-requests.html @@ -0,0 +1,14 @@ + + + +KVServiceManager.deleteRequests - kvision + + + +kvision / pl.treksoft.kvision.remote / KVServiceManager / deleteRequests
+
+

deleteRequests

+ +val deleteRequests: MutableMap<String, (Request, <ERROR CLASS>) -> Unit> + + diff --git a/api/pl.treksoft.kvision.remote/-k-v-service-manager/get-calls.html b/api/pl.treksoft.kvision.remote/-k-v-service-manager/get-calls.html new file mode 100644 index 00000000..f665a679 --- /dev/null +++ b/api/pl.treksoft.kvision.remote/-k-v-service-manager/get-calls.html @@ -0,0 +1,15 @@ + + + +KVServiceManager.getCalls - kvision + + + +kvision / pl.treksoft.kvision.remote / KVServiceManager / getCalls
+
+

getCalls

+ +open fun getCalls(): Map<String, Pair<String, RpcHttpMethod>> +

Returns the map of defined paths.

+ + diff --git a/api/pl.treksoft.kvision.remote/-k-v-service-manager/get-parameter.html b/api/pl.treksoft.kvision.remote/-k-v-service-manager/get-parameter.html new file mode 100644 index 00000000..60238eef --- /dev/null +++ b/api/pl.treksoft.kvision.remote/-k-v-service-manager/get-parameter.html @@ -0,0 +1,14 @@ + + + +KVServiceManager.getParameter - kvision + + + +kvision / pl.treksoft.kvision.remote / KVServiceManager / getParameter
+
+

getParameter

+ +protected inline fun <reified T> getParameter(str: String?): T + + diff --git a/api/pl.treksoft.kvision.remote/-k-v-service-manager/index.html b/api/pl.treksoft.kvision.remote/-k-v-service-manager/index.html new file mode 100644 index 00000000..c3d7aa1e --- /dev/null +++ b/api/pl.treksoft.kvision.remote/-k-v-service-manager/index.html @@ -0,0 +1,169 @@ + + + +KVServiceManager - kvision + + + +kvision / pl.treksoft.kvision.remote / KVServiceManager
+
+

KVServiceManager

+open actual class KVServiceManager<T : Any> +

Multiplatform service manager.

Constructors

+ + + + + + + +

<init>

+KVServiceManager(serviceClass: KClass<T>) +

Multiplatform service manager.

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+ calls +	+`val calls: MutableMap<String, Pair<String, RpcHttpMethod>>`
+ counter +	+`var counter: Int`
+ deleteRequests +	+`val deleteRequests: MutableMap<String, (Request, <ERROR CLASS>) -> Unit>`
+ mapper +	+`val mapper: <ERROR CLASS>`
+ optionsRequests +	+`val optionsRequests: MutableMap<String, (Request, <ERROR CLASS>) -> Unit>`
+ postRequests +	+`val postRequests: MutableMap<String, (Request, <ERROR CLASS>) -> Unit>`
+ putRequests +	+`val putRequests: MutableMap<String, (Request, <ERROR CLASS>) -> Unit>`
+ routes +	+`val routes: MutableList<KVServer.() -> Unit>`
+ serviceClass +	+`val serviceClass: KClass<T>`

Functions

+ + + + + + + + + + + + +

+ addRoute +	+`fun addRoute(method: RpcHttpMethod, path: String, handler: (Request, <ERROR CLASS>) -> Unit): Unit`
+ applyRoutes +	+`actual fun applyRoutes(k: KVServer): Unit` + Applies all defined routes to the given server. +Not used on the js platform. +
+ bind +	+`actual fun <RET> bind(function: suspend T.() -> RET, route: String?, method: RpcHttpMethod): Unit` +`actual fun <PAR, RET> bind(function: suspend T.(PAR) -> RET, route: String?, method: RpcHttpMethod): Unit` +`actual fun <PAR1, PAR2, RET> bind(function: suspend T.(PAR1, PAR2) -> RET, route: String?, method: RpcHttpMethod): Unit` +`actual fun <PAR1, PAR2, PAR3, RET> bind(function: suspend T.(PAR1, PAR2, PAR3) -> RET, route: String?, method: RpcHttpMethod): Unit` +`actual fun <PAR1, PAR2, PAR3, PAR4, RET> bind(function: suspend T.(PAR1`