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 --- .../-jooby-service-manager/-init-.html | 15 +++ .../-jooby-service-manager/-l-o-g.html | 14 ++ .../-jooby-service-manager/apply-routes.html | 18 +++ .../-jooby-service-manager/bind.html | 32 +++++ .../-jooby-service-manager/call.html | 14 ++ .../-jooby-service-manager/calls.html | 14 ++ .../-jooby-service-manager/counter.html | 14 ++ .../-jooby-service-manager/get-calls.html | 16 +++ .../-jooby-service-manager/get-parameter.html | 14 ++ .../-jooby-service-manager/index.html | 145 +++++++++++++++++++++ .../-jooby-service-manager/mapper.html | 14 ++ .../-jooby-service-manager/routes.html | 14 ++ .../-jooby-service-manager/service.html | 14 ++ 13 files changed, 338 insertions(+) create mode 100644 api/kvision/pl.treksoft.kvision.remote/-jooby-service-manager/-init-.html create mode 100644 api/kvision/pl.treksoft.kvision.remote/-jooby-service-manager/-l-o-g.html create mode 100644 api/kvision/pl.treksoft.kvision.remote/-jooby-service-manager/apply-routes.html create mode 100644 api/kvision/pl.treksoft.kvision.remote/-jooby-service-manager/bind.html create mode 100644 api/kvision/pl.treksoft.kvision.remote/-jooby-service-manager/call.html create mode 100644 api/kvision/pl.treksoft.kvision.remote/-jooby-service-manager/calls.html create mode 100644 api/kvision/pl.treksoft.kvision.remote/-jooby-service-manager/counter.html create mode 100644 api/kvision/pl.treksoft.kvision.remote/-jooby-service-manager/get-calls.html create mode 100644 api/kvision/pl.treksoft.kvision.remote/-jooby-service-manager/get-parameter.html create mode 100644 api/kvision/pl.treksoft.kvision.remote/-jooby-service-manager/index.html create mode 100644 api/kvision/pl.treksoft.kvision.remote/-jooby-service-manager/mapper.html create mode 100644 api/kvision/pl.treksoft.kvision.remote/-jooby-service-manager/routes.html create mode 100644 api/kvision/pl.treksoft.kvision.remote/-jooby-service-manager/service.html (limited to 'api/kvision/pl.treksoft.kvision.remote/-jooby-service-manager') diff --git a/api/kvision/pl.treksoft.kvision.remote/-jooby-service-manager/-init-.html b/api/kvision/pl.treksoft.kvision.remote/-jooby-service-manager/-init-.html new file mode 100644 index 00000000..67af7141 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.remote/-jooby-service-manager/-init-.html @@ -0,0 +1,15 @@ + + + +JoobyServiceManager.<init> - kvision + + + +kvision / pl.treksoft.kvision.remote / JoobyServiceManager / <init>
+
+

<init>

+ +JoobyServiceManager(service: T) +

Multiplatform service manager for Jooby.

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

LOG

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

applyRoutes

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

Applies all defined routes to the given server.

Parameters

+k - a server

+ + diff --git a/api/kvision/pl.treksoft.kvision.remote/-jooby-service-manager/bind.html b/api/kvision/pl.treksoft.kvision.remote/-jooby-service-manager/bind.html new file mode 100644 index 00000000..5c2ccb21 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.remote/-jooby-service-manager/bind.html @@ -0,0 +1,32 @@ + + + +JoobyServiceManager.bind - kvision + + + +kvision / pl.treksoft.kvision.remote / JoobyServiceManager / bind
+
+

bind

+ +

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

+ +

protected inline fun <reified PAR, reified RET> bind(noinline function: T.(PAR, Request?) -> Deferred<RET>, route: String? = null, method: RpcHttpMethod = RpcHttpMethod.POST): 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): 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): 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): 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): 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

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

call

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

calls

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

counter

+ +var counter: Int + + diff --git a/api/kvision/pl.treksoft.kvision.remote/-jooby-service-manager/get-calls.html b/api/kvision/pl.treksoft.kvision.remote/-jooby-service-manager/get-calls.html new file mode 100644 index 00000000..0957bf20 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.remote/-jooby-service-manager/get-calls.html @@ -0,0 +1,16 @@ + + + +JoobyServiceManager.getCalls - kvision + + + +kvision / pl.treksoft.kvision.remote / JoobyServiceManager / getCalls
+
+

getCalls

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

Overrides ServiceManager.getCalls

Returns the map of defined paths.

+ + diff --git a/api/kvision/pl.treksoft.kvision.remote/-jooby-service-manager/get-parameter.html b/api/kvision/pl.treksoft.kvision.remote/-jooby-service-manager/get-parameter.html new file mode 100644 index 00000000..99b992b5 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.remote/-jooby-service-manager/get-parameter.html @@ -0,0 +1,14 @@ + + + +JoobyServiceManager.getParameter - kvision + + + +kvision / pl.treksoft.kvision.remote / JoobyServiceManager / getParameter
+
+

getParameter

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

JoobyServiceManager

+open expect class JoobyServiceManager<T : Any> : ServiceManager +

Multiplatform service manager for Jooby.

Constructors

+ + + + + + + +

<init>

+JoobyServiceManager(service: T) +

Multiplatform service manager for Jooby.

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): Unit

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

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

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

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

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