From 7c2850063697f94a0d8b8d8f8588136dd4b3d05e Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Sun, 21 Oct 2018 23:59:34 +0200 Subject: API documentation for KVision 0.0.19 --- .../-service-manager/-init-.html | 15 --- .../-service-manager/-l-o-g.html | 14 --- .../-service-manager/apply-routes.html | 18 --- .../-service-manager/bind.html | 34 ------ .../-service-manager/call.html | 14 --- .../-service-manager/calls.html | 14 --- .../-service-manager/counter.html | 14 --- .../-service-manager/get-calls.html | 15 --- .../-service-manager/get-parameter.html | 14 --- .../-service-manager/index.html | 131 --------------------- .../-service-manager/mapper.html | 14 --- .../-service-manager/routes.html | 14 --- .../-service-manager/service.html | 14 --- 13 files changed, 325 deletions(-) delete mode 100644 api/pl.treksoft.kvision.remote/-service-manager/-init-.html delete mode 100644 api/pl.treksoft.kvision.remote/-service-manager/-l-o-g.html delete mode 100644 api/pl.treksoft.kvision.remote/-service-manager/apply-routes.html delete mode 100644 api/pl.treksoft.kvision.remote/-service-manager/bind.html delete mode 100644 api/pl.treksoft.kvision.remote/-service-manager/call.html delete mode 100644 api/pl.treksoft.kvision.remote/-service-manager/calls.html delete mode 100644 api/pl.treksoft.kvision.remote/-service-manager/counter.html delete mode 100644 api/pl.treksoft.kvision.remote/-service-manager/get-calls.html delete mode 100644 api/pl.treksoft.kvision.remote/-service-manager/get-parameter.html delete mode 100644 api/pl.treksoft.kvision.remote/-service-manager/index.html delete mode 100644 api/pl.treksoft.kvision.remote/-service-manager/mapper.html delete mode 100644 api/pl.treksoft.kvision.remote/-service-manager/routes.html delete mode 100644 api/pl.treksoft.kvision.remote/-service-manager/service.html (limited to 'api/pl.treksoft.kvision.remote/-service-manager') diff --git a/api/pl.treksoft.kvision.remote/-service-manager/-init-.html b/api/pl.treksoft.kvision.remote/-service-manager/-init-.html deleted file mode 100644 index bf9fee57..00000000 --- a/api/pl.treksoft.kvision.remote/-service-manager/-init-.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -ServiceManager.<init> - kvision - - - -kvision / pl.treksoft.kvision.remote / ServiceManager / <init>
-
-

<init>

- -ServiceManager(service: T) -

Multiplatform service manager.

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

LOG

- -val LOG: <ERROR CLASS> - - diff --git a/api/pl.treksoft.kvision.remote/-service-manager/apply-routes.html b/api/pl.treksoft.kvision.remote/-service-manager/apply-routes.html deleted file mode 100644 index 3e88056f..00000000 --- a/api/pl.treksoft.kvision.remote/-service-manager/apply-routes.html +++ /dev/null @@ -1,18 +0,0 @@ - - - -ServiceManager.applyRoutes - kvision - - - -kvision / pl.treksoft.kvision.remote / ServiceManager / applyRoutes
-
-

applyRoutes

- -fun applyRoutes(k: KVServer): Unit -

Applies all defined routes to the given server.

Parameters

-k - a server

- - diff --git a/api/pl.treksoft.kvision.remote/-service-manager/bind.html b/api/pl.treksoft.kvision.remote/-service-manager/bind.html deleted file mode 100644 index 37a493f8..00000000 --- a/api/pl.treksoft.kvision.remote/-service-manager/bind.html +++ /dev/null @@ -1,34 +0,0 @@ - - - -ServiceManager.bind - kvision - - - -kvision / pl.treksoft.kvision.remote / ServiceManager / bind
-
-

bind

- -

protected inline fun <reified RET> bind(noinline function: T.(Request?) -> Deferred<RET>, route: String? = null, method: RpcHttpMethod = RpcHttpMethod.POST, prefix: String = "/"): Unit

- -

protected inline fun <reified PAR, reified RET> bind(noinline function: T.(PAR, Request?) -> Deferred<RET>, route: String? = null, method: RpcHttpMethod = RpcHttpMethod.POST, prefix: String = "/"): Unit

- -

protected inline fun <reified PAR1, reified PAR2, reified RET> bind(noinline function: T.(PAR1, PAR2, Request?) -> Deferred<RET>, route: String? = null, method: RpcHttpMethod = RpcHttpMethod.POST, prefix: String = "/"): Unit

- -

protected inline fun <reified PAR1, reified PAR2, reified PAR3, reified RET> bind(noinline function: T.(PAR1, PAR2, PAR3, Request?) -> Deferred<RET>, route: String? = null, method: RpcHttpMethod = RpcHttpMethod.POST, prefix: String = "/"): Unit

- -

protected inline fun <reified PAR1, reified PAR2, reified PAR3, reified PAR4, reified RET> bind(noinline function: T.(PAR1, PAR2, PAR3, PAR4, Request?) -> Deferred<RET>, route: String? = null, method: RpcHttpMethod = RpcHttpMethod.POST, prefix: String = "/"): Unit

- -

protected inline fun <reified PAR1, reified PAR2, reified PAR3, reified PAR4, reified PAR5, reified RET> bind(noinline function: T.(PAR1, PAR2, PAR3, PAR4, PAR5, Request?) -> Deferred<RET>, route: String? = null, method: RpcHttpMethod = RpcHttpMethod.POST, prefix: String = "/"): 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

-prefix - an URL address prefix

- - diff --git a/api/pl.treksoft.kvision.remote/-service-manager/call.html b/api/pl.treksoft.kvision.remote/-service-manager/call.html deleted file mode 100644 index 650fe088..00000000 --- a/api/pl.treksoft.kvision.remote/-service-manager/call.html +++ /dev/null @@ -1,14 +0,0 @@ - - - -ServiceManager.call - kvision - - - -kvision / pl.treksoft.kvision.remote / ServiceManager / call
-
-

call

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

calls

- -protected val calls: MutableMap<String, Pair<String, RpcHttpMethod>> - - diff --git a/api/pl.treksoft.kvision.remote/-service-manager/counter.html b/api/pl.treksoft.kvision.remote/-service-manager/counter.html deleted file mode 100644 index 183b676d..00000000 --- a/api/pl.treksoft.kvision.remote/-service-manager/counter.html +++ /dev/null @@ -1,14 +0,0 @@ - - - -ServiceManager.counter - kvision - - - -kvision / pl.treksoft.kvision.remote / ServiceManager / counter
-
-

counter

- -var counter: Int - - diff --git a/api/pl.treksoft.kvision.remote/-service-manager/get-calls.html b/api/pl.treksoft.kvision.remote/-service-manager/get-calls.html deleted file mode 100644 index 65049452..00000000 --- a/api/pl.treksoft.kvision.remote/-service-manager/get-calls.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -ServiceManager.getCalls - kvision - - - -kvision / pl.treksoft.kvision.remote / ServiceManager / getCalls
-
-

getCalls

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

Returns the map of defined paths.

- - diff --git a/api/pl.treksoft.kvision.remote/-service-manager/get-parameter.html b/api/pl.treksoft.kvision.remote/-service-manager/get-parameter.html deleted file mode 100644 index d0995027..00000000 --- a/api/pl.treksoft.kvision.remote/-service-manager/get-parameter.html +++ /dev/null @@ -1,14 +0,0 @@ - - - -ServiceManager.getParameter - kvision - - - -kvision / pl.treksoft.kvision.remote / ServiceManager / getParameter
-
-

getParameter

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

ServiceManager

-open expect class ServiceManager<out T> -

Multiplatform service manager.

Constructors

- - - - - - - -

<init>

-ServiceManager(service: T) -

Multiplatform service manager.

Properties

- - - - - - - - - - - - - - - - - - - - - - - -

- calls -	-`val calls: MutableMap<String, Pair<String, RpcHttpMethod>>`
- counter -	-`var counter: Int`
- mapper -	-`val mapper: <ERROR CLASS>`
- routes -	-`val routes: MutableList<KVServer.() -> Unit>`
- service -	-`val service: T`

Functions

- - - - - - - - - - - - - - - - - - - - - - - -

- applyRoutes -	-`fun applyRoutes(k: KVServer): Unit` - Applies all defined routes to the given server. -
- bind -	-`fun <RET> bind(function: T.(Request?) -> Deferred<RET>, route: String? = null, method: RpcHttpMethod = RpcHttpMethod.POST, prefix: String = "/"): Unit` -`fun <PAR, RET> bind(function: T.(PAR, Request?) -> Deferred<RET>, route: String? = null, method: RpcHttpMethod = RpcHttpMethod.POST, prefix: String = "/"): Unit` -`fun <PAR1, PAR2, RET> bind(function: T.(PAR1, PAR2, Request?) -> Deferred<RET>, route: String? = null, method: RpcHttpMethod = RpcHttpMethod.POST, prefix: String = "/"): Unit` -`fun <PAR1, PAR2, PAR3, RET> bind(function: T.(PAR1, PAR2, PAR3, Request?) -> Deferred<RET>, route: String? = null, method: RpcHttpMethod = RpcHttpMethod.POST, prefix: String = "/"): Unit` -`fun <PAR1, PAR2, PAR3, PAR4, RET> bind(function: T.(PAR1, PAR2, PAR3, PAR4, Request?) -> Deferred<RET>, route: String? = null, method: RpcHttpMethod = RpcHttpMethod.POST, prefix: String = "/"): Unit` -`fun <PAR1, PAR2, PAR3, PAR4, PAR5, RET> bind(function: T.(PAR1, PAR2, PAR3, PAR4, PAR5, Request?) -> Deferred<RET>, route: String? = null, method: RpcHttpMethod = RpcHttpMethod.POST, prefix: String = "/"): Unit` - Binds a given route with a function of the receiver. -
- call -	-`fun call(method: RpcHttpMethod, path: String, handler: (Request, <ERROR CLASS>) -> Unit): KVServer.() -> Unit`
- getCalls -	-`fun getCalls(): Map<String, Pair<String, RpcHttpMethod>>` - Returns the map of defined paths. -
- getParameter -	-`fun <T> getParameter(str: String?): T`

Companion Object Properties

- - - - - - - -

LOG

-val LOG: <ERROR CLASS>

- - diff --git a/api/pl.treksoft.kvision.remote/-service-manager/mapper.html b/api/pl.treksoft.kvision.remote/-service-manager/mapper.html deleted file mode 100644 index 083431c4..00000000 --- a/api/pl.treksoft.kvision.remote/-service-manager/mapper.html +++ /dev/null @@ -1,14 +0,0 @@ - - - -ServiceManager.mapper - kvision - - - -kvision / pl.treksoft.kvision.remote / ServiceManager / mapper
-
-

mapper

- -val mapper: <ERROR CLASS> - - diff --git a/api/pl.treksoft.kvision.remote/-service-manager/routes.html b/api/pl.treksoft.kvision.remote/-service-manager/routes.html deleted file mode 100644 index dbd562e3..00000000 --- a/api/pl.treksoft.kvision.remote/-service-manager/routes.html +++ /dev/null @@ -1,14 +0,0 @@ - - - -ServiceManager.routes - kvision - - - -kvision / pl.treksoft.kvision.remote / ServiceManager / routes
-
-

routes

- -protected val routes: MutableList<KVServer.() -> Unit> - - diff --git a/api/pl.treksoft.kvision.remote/-service-manager/service.html b/api/pl.treksoft.kvision.remote/-service-manager/service.html deleted file mode 100644 index 514980ce..00000000 --- a/api/pl.treksoft.kvision.remote/-service-manager/service.html +++ /dev/null @@ -1,14 +0,0 @@ - - - -ServiceManager.service - kvision - - - -kvision / pl.treksoft.kvision.remote / ServiceManager / service
-
-

service

- -val service: T - - -- cgit