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 --- .../-spring-service-manager/-init-.html | 15 ++ .../-spring-service-manager/-l-o-g.html | 14 ++ .../-spring-service-manager/add-route.html | 14 ++ .../-spring-service-manager/bind.html | 32 +++++ .../-spring-service-manager/calls.html | 14 ++ .../-spring-service-manager/counter.html | 14 ++ .../-spring-service-manager/delete-requests.html | 14 ++ .../-spring-service-manager/get-calls.html | 16 +++ .../-spring-service-manager/get-parameter.html | 14 ++ .../-spring-service-manager/index.html | 157 +++++++++++++++++++++ .../-spring-service-manager/mapper.html | 14 ++ .../-spring-service-manager/options-requests.html | 14 ++ .../-spring-service-manager/post-requests.html | 14 ++ .../-spring-service-manager/put-requests.html | 14 ++ .../-spring-service-manager/service-class.html | 14 ++ 15 files changed, 374 insertions(+) create mode 100644 api/kvision/pl.treksoft.kvision.remote/-spring-service-manager/-init-.html create mode 100644 api/kvision/pl.treksoft.kvision.remote/-spring-service-manager/-l-o-g.html create mode 100644 api/kvision/pl.treksoft.kvision.remote/-spring-service-manager/add-route.html create mode 100644 api/kvision/pl.treksoft.kvision.remote/-spring-service-manager/bind.html create mode 100644 api/kvision/pl.treksoft.kvision.remote/-spring-service-manager/calls.html create mode 100644 api/kvision/pl.treksoft.kvision.remote/-spring-service-manager/counter.html create mode 100644 api/kvision/pl.treksoft.kvision.remote/-spring-service-manager/delete-requests.html create mode 100644 api/kvision/pl.treksoft.kvision.remote/-spring-service-manager/get-calls.html create mode 100644 api/kvision/pl.treksoft.kvision.remote/-spring-service-manager/get-parameter.html create mode 100644 api/kvision/pl.treksoft.kvision.remote/-spring-service-manager/index.html create mode 100644 api/kvision/pl.treksoft.kvision.remote/-spring-service-manager/mapper.html create mode 100644 api/kvision/pl.treksoft.kvision.remote/-spring-service-manager/options-requests.html create mode 100644 api/kvision/pl.treksoft.kvision.remote/-spring-service-manager/post-requests.html create mode 100644 api/kvision/pl.treksoft.kvision.remote/-spring-service-manager/put-requests.html create mode 100644 api/kvision/pl.treksoft.kvision.remote/-spring-service-manager/service-class.html (limited to 'api/kvision/pl.treksoft.kvision.remote/-spring-service-manager') diff --git a/api/kvision/pl.treksoft.kvision.remote/-spring-service-manager/-init-.html b/api/kvision/pl.treksoft.kvision.remote/-spring-service-manager/-init-.html new file mode 100644 index 00000000..59109334 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.remote/-spring-service-manager/-init-.html @@ -0,0 +1,15 @@ + + + +SpringServiceManager.<init> - kvision + + + +kvision / pl.treksoft.kvision.remote / SpringServiceManager / <init>
+
+

<init>

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

Multiplatform service manager for Spring Boot.

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

LOG

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

addRoute

+ +fun addRoute(method: RpcHttpMethod, path: String, handler: (Request, <ERROR CLASS>) -> Unit): Unit + + diff --git a/api/kvision/pl.treksoft.kvision.remote/-spring-service-manager/bind.html b/api/kvision/pl.treksoft.kvision.remote/-spring-service-manager/bind.html new file mode 100644 index 00000000..c128d916 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.remote/-spring-service-manager/bind.html @@ -0,0 +1,32 @@ + + + +SpringServiceManager.bind - kvision + + + +kvision / pl.treksoft.kvision.remote / SpringServiceManager / bind
+
+

bind

+ +protected inline fun <reified RET> bind(noinline function: T.() -> Deferred<RET>, route: String? = null, method: RpcHttpMethod = RpcHttpMethod.POST): Unit
+ +protected inline fun <reified PAR, reified RET> bind(noinline function: T.(PAR) -> 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) -> 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) -> 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) -> 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) -> 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/-spring-service-manager/calls.html b/api/kvision/pl.treksoft.kvision.remote/-spring-service-manager/calls.html new file mode 100644 index 00000000..65bee773 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.remote/-spring-service-manager/calls.html @@ -0,0 +1,14 @@ + + + +SpringServiceManager.calls - kvision + + + +kvision / pl.treksoft.kvision.remote / SpringServiceManager / calls
+
+

calls

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

counter

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

deleteRequests

+ +val deleteRequests: MutableMap<String, (Request, <ERROR CLASS>) -> Unit> + + diff --git a/api/kvision/pl.treksoft.kvision.remote/-spring-service-manager/get-calls.html b/api/kvision/pl.treksoft.kvision.remote/-spring-service-manager/get-calls.html new file mode 100644 index 00000000..f9e9f953 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.remote/-spring-service-manager/get-calls.html @@ -0,0 +1,16 @@ + + + +SpringServiceManager.getCalls - kvision + + + +kvision / pl.treksoft.kvision.remote / SpringServiceManager / 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/-spring-service-manager/get-parameter.html b/api/kvision/pl.treksoft.kvision.remote/-spring-service-manager/get-parameter.html new file mode 100644 index 00000000..567b07b3 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.remote/-spring-service-manager/get-parameter.html @@ -0,0 +1,14 @@ + + + +SpringServiceManager.getParameter - kvision + + + +kvision / pl.treksoft.kvision.remote / SpringServiceManager / getParameter
+
+

getParameter

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

SpringServiceManager

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

Multiplatform service manager for Spring Boot.

+

Constructors

+ + + + + + + +
+

<init>

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

Multiplatform service manager for Spring Boot.

+
+

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>
+

serviceClass

+
+val serviceClass: KClass<T>
+

Functions

+ + + + + + + + +
+

addRoute

+
+fun addRoute(method: RpcHttpMethod, path: String, handler: (Request, <ERROR CLASS>) -> Unit): Unit
+

bind

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