From a70acf853de62d0754ca95aa4103712b82afdef8 Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Wed, 17 Oct 2018 18:40:15 +0200 Subject: API Documentation for KVision 0.0.18 --- .../-service-manager/-l-o-g.html | 14 +++++ .../-service-manager/apply-routes.html | 10 ++-- .../-service-manager/bind.html | 24 ++++---- .../-service-manager/call.html | 14 +++++ .../-service-manager/calls.html | 2 +- .../-service-manager/get-calls.html | 2 +- .../-service-manager/get-parameter.html | 14 +++++ .../-service-manager/index.html | 70 ++++++++++++++++++---- .../-service-manager/mapper.html | 14 +++++ .../-service-manager/routes.html | 14 +++++ .../-service-manager/service.html | 14 +++++ 11 files changed, 162 insertions(+), 30 deletions(-) create mode 100644 api/pl.treksoft.kvision.remote/-service-manager/-l-o-g.html create mode 100644 api/pl.treksoft.kvision.remote/-service-manager/call.html create mode 100644 api/pl.treksoft.kvision.remote/-service-manager/get-parameter.html create mode 100644 api/pl.treksoft.kvision.remote/-service-manager/mapper.html create mode 100644 api/pl.treksoft.kvision.remote/-service-manager/routes.html create 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/-l-o-g.html b/api/pl.treksoft.kvision.remote/-service-manager/-l-o-g.html new file mode 100644 index 00000000..0e4d83c1 --- /dev/null +++ b/api/pl.treksoft.kvision.remote/-service-manager/-l-o-g.html @@ -0,0 +1,14 @@ + + + +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 index 36f7a1e4..3e88056f 100644 --- a/api/pl.treksoft.kvision.remote/-service-manager/apply-routes.html +++ b/api/pl.treksoft.kvision.remote/-service-manager/apply-routes.html @@ -8,9 +8,11 @@ kvision / pl.treksoft.kvision.remote / ServiceManager / applyRoutes

applyRoutes

- -actual fun applyRoutes(k: JoobyServer): Unit -

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

+ +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 index a8353fa7..37a493f8 100644 --- a/api/pl.treksoft.kvision.remote/-service-manager/bind.html +++ b/api/pl.treksoft.kvision.remote/-service-manager/bind.html @@ -8,18 +8,18 @@ kvision / pl.treksoft.kvision.remote / ServiceManager / bind

bind

- -

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

- -

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

- -

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

- -

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

- -

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

- -

protected inline actual 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?, method: RpcHttpMethod, prefix: String): Unit

+ +

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

diff --git a/api/pl.treksoft.kvision.remote/-service-manager/call.html b/api/pl.treksoft.kvision.remote/-service-manager/call.html new file mode 100644 index 00000000..650fe088 --- /dev/null +++ b/api/pl.treksoft.kvision.remote/-service-manager/call.html @@ -0,0 +1,14 @@ + + + +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 index 4eeea9b5..bb0fa846 100644 --- a/api/pl.treksoft.kvision.remote/-service-manager/calls.html +++ b/api/pl.treksoft.kvision.remote/-service-manager/calls.html @@ -9,6 +9,6 @@

calls

-protected val calls: MutableMap<String, Pair<String, RpcHttpMethod>> +protected val calls: MutableMap<String, Pair<String, RpcHttpMethod>> diff --git a/api/pl.treksoft.kvision.remote/-service-manager/get-calls.html b/api/pl.treksoft.kvision.remote/-service-manager/get-calls.html index 45bbe853..65049452 100644 --- a/api/pl.treksoft.kvision.remote/-service-manager/get-calls.html +++ b/api/pl.treksoft.kvision.remote/-service-manager/get-calls.html @@ -9,7 +9,7 @@

getCalls

-actual fun getCalls(): Map<String, Pair<String, RpcHttpMethod>> +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 new file mode 100644 index 00000000..d0995027 --- /dev/null +++ b/api/pl.treksoft.kvision.remote/-service-manager/get-parameter.html @@ -0,0 +1,14 @@ + + + +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 index c146b9df..e51b8a0e 100644 --- a/api/pl.treksoft.kvision.remote/-service-manager/index.html +++ b/api/pl.treksoft.kvision.remote/-service-manager/index.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.remote / ServiceManager

ServiceManager

-open actual class ServiceManager<out T> +open expect class ServiceManager<out T>

Multiplatform service manager.

Constructors

@@ -32,7 +32,7 @@

calls

+val calls: MutableMap<String, Pair<String, RpcHttpMethod>> + + + + + + + + + + + +

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

Functions

@@ -51,9 +72,8 @@

applyRoutes

-actual fun applyRoutes(k: JoobyServer): Unit -

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

+fun applyRoutes(k: KVServer): Unit +

Applies all defined routes to the given server.

@@ -61,24 +81,50 @@ Not used on the js platform.

bind

actual fun <RET> bind(function: T.(Request?) -> Deferred<RET>, route: String?, method: RpcHttpMethod, prefix: String): Unit

actual fun <PAR, RET> bind(function: T.(PAR, Request?) -> Deferred<RET>, route: String?, method: RpcHttpMethod, prefix: String): Unit

actual fun <PAR1, PAR2, RET> bind(function: T.(PAR1, PAR2, Request?) -> Deferred<RET>, route: String?, method: RpcHttpMethod, prefix: String): Unit

actual fun <PAR1, PAR2, PAR3, RET> bind(function: T.(PAR1, PAR2, PAR3, Request?) -> Deferred<RET>, route: String?, method: RpcHttpMethod, prefix: String): Unit

actual fun <PAR1, PAR2, PAR3, PAR4, RET> bind(function: T.(PAR1, PAR2, PAR3, PAR4, Request?) -> Deferred<RET>, route: String?, method: RpcHttpMethod, prefix: String): Unit

actual fun <PAR1, PAR2, PAR3, PAR4, PAR5, RET> bind(function: T.(PAR1, PAR2, PAR3, PAR4, PAR5, Request?) -> Deferred<RET>, route: String?, method: RpcHttpMethod, prefix: String): Unit

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

-actual fun getCalls(): Map<String, Pair<String, RpcHttpMethod>> +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 new file mode 100644 index 00000000..083431c4 --- /dev/null +++ b/api/pl.treksoft.kvision.remote/-service-manager/mapper.html @@ -0,0 +1,14 @@ + + + +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 new file mode 100644 index 00000000..dbd562e3 --- /dev/null +++ b/api/pl.treksoft.kvision.remote/-service-manager/routes.html @@ -0,0 +1,14 @@ + + + +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 new file mode 100644 index 00000000..514980ce --- /dev/null +++ b/api/pl.treksoft.kvision.remote/-service-manager/service.html @@ -0,0 +1,14 @@ + + + +ServiceManager.service - kvision + + + +kvision / pl.treksoft.kvision.remote / ServiceManager / service
+
+

service

+ +val service: T + + -- cgit