Module Contents

From e361ab18f355ff81ef61406543b918d4a2b9567c Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Thu, 11 Apr 2019 18:02:54 +0200 Subject: API documentantion for KVision 0.0.33 --- api/index-outline.html | 218 ++++++++++++++++++++----------------------------- 1 file changed, 90 insertions(+), 128 deletions(-) (limited to 'api/index-outline.html') diff --git a/api/index-outline.html b/api/index-outline.html index 70583ba6..0d496f51 100644 --- a/api/index-outline.html +++ b/api/index-outline.html @@ -1209,20 +1209,6 @@ -class CallModule
-

Module Contents

CallModule(call: <ERROR CLASS>)

fun configure():

open class Canvas : Widget

@@ -3864,29 +3850,7 @@ -class DummyWebSocketServerSession
-

Module Contents

DummyWebSocketServerSession()

val call: <ERROR CLASS>

suspend fun close(cause:

?

)

:

val coroutineContext:

CoroutineContext

suspend fun flush():

val incoming: <ERROR CLASS><<ERROR CLASS>>

var maxFrameSize:

val outgoing: <ERROR CLASS><<ERROR CLASS>>

fun terminate():

-class DummyWsSessionModule
+open class DummyWebSocketSession

DummyWsSessionModule()

fun configure():

DummyWebSocketSession()

open fun close():

open fun close(status: <ERROR CLASS>):

open fun getAcceptedProtocol():

?

open fun getAttributes():

<

,

>

open fun getBinaryMessageSizeLimit():

open fun getExtensions():

<

<ERROR CLASS>

>

open fun getHandshakeHeaders(): <ERROR CLASS>

open fun getId():

open fun getLocalAddress():

InetSocketAddress

?

open fun getPrincipal():

?

open fun getRemoteAddress():

InetSocketAddress

?

open fun getTextMessageSizeLimit():

open fun getUri():

?

open fun isOpen():

open fun sendMessage(message: <ERROR CLASS><out <ERROR CLASS>>):

open fun setBinaryMessageSizeLimit(messageSizeLimit:

)

:

open fun setTextMessageSizeLimit(messageSizeLimit:

)

:

@@ -5753,8 +5733,6 @@ KVServiceManager(serviceClass: KClass<T>)
-fun addRoute(method: HttpMethod, path: String, handler: suspend <ERROR CLASS><Unit, <ERROR CLASS>>.(Unit) -> Unit): Unit
-fun addRoute(method: HttpMethod, path: String, handler: (<ERROR CLASS>, <ERROR CLASS>, <ERROR CLASS>) -> Unit): Unit
protected actual inline fun <reified RET> bind(noinline function: suspend T.() -> RET, method: HttpMethod, route: String?): Unit
protected actual inline fun <reified PAR, reified RET> bind(noinline function: suspend T.(PAR) -> RET, method: HttpMethod, route: String?): Unit
protected actual inline fun <reified PAR1, reified PAR2, reified RET> bind(noinline function: suspend T.(PAR1, PAR2) -> RET, method: HttpMethod, route: String?): Unit
@@ -5763,12 +5741,10 @@ protected actual inline fun <reified PAR1, reified PAR2, reified PAR3, reified PAR4, reified PAR5, reified RET> bind(noinline function: suspend T.(PAR1, PAR2, PAR3, PAR4, PAR5) -> RET, method: HttpMethod, route: String?): Unit
protected actual fun bind(function: T.(String?, String?) -> List<<ERROR CLASS>>): Unit
protected actual inline fun <reified PAR1 : Any, reified PAR2 : Any> bind(noinline function: suspend T.(<ERROR CLASS><PAR1>, <ERROR CLASS><PAR2>) -> Unit, route: String?): Unit
-fun call(method: HttpMethod, path: String, handler: (<ERROR CLASS>, <ERROR CLASS>) -> Unit): <ERROR CLASS>.() -> Unit
protected val calls: MutableMap<String, Pair<String, HttpMethod>>
var counter: Int
val deleteRequests: MutableMap<String, suspend <ERROR CLASS><Unit, <ERROR CLASS>>.(Unit) -> Unit>
fun getCalls(): Map<String, Pair<String, HttpMethod>>
-protected inline fun <reified T> getParameter(str: String?): T
val getRequests: MutableMap<String, suspend <ERROR CLASS><Unit, <ERROR CLASS>>.(Unit) -> Unit>
val LOG: <ERROR CLASS>
val mapper: <ERROR CLASS>
@@ -5778,6 +5754,26 @@ val routes: MutableList<<ERROR CLASS>.() -> Unit>
val serviceClass: KClass<T>
val webSocketRequests: MutableMap<String, suspend <ERROR CLASS>.() -> Unit>
+val webSocketsRequests: MutableMap<String, suspend (<ERROR CLASS>, <ERROR CLASS>, <ERROR CLASS><String>, <ERROR CLASS><String>) -> Unit>
+ + + +open class KVWebSocketConfig
+

Module Contents

KVWebSocketConfig()

lateinit var applicationContext: <ERROR CLASS>

open fun registerWebSocketHandlers(registry: <ERROR CLASS>):

open fun routeInterceptor(): <ERROR CLASS>

lateinit var services:

<

KVServiceManager

<

*

>

>

open fun socketHandler(): <ERROR CLASS>

open fun webSocketSession(): <ERROR CLASS>

@@ -6119,20 +6115,6 @@ -class MainModule
-

Module Contents

MainModule(application: <ERROR CLASS>)

fun configure():

external interface MediaFlags

@@ -11051,6 +11033,19 @@ +object WebSocketSessionHolder
+

Module Contents

var webSocketSession: <ERROR CLASS>

external interface WebSource

@@ -11382,20 +11377,6 @@ -class WsSessionModule
-

Module Contents

WsSessionModule(webSocketSession: <ERROR CLASS>)

fun configure():

@@ -22397,20 +22378,6 @@ -class CallModule
-

Module Contents

CallModule(call: <ERROR CLASS>)

fun configure():

data class Credentials

@@ -22426,7 +22393,7 @@ -class DummyWebSocketServerSession
+open class DummyWebSocketSession

DummyWebSocketServerSession()

val call: <ERROR CLASS>

suspend fun close(cause:

?

)

:

val coroutineContext:

CoroutineContext

suspend fun flush():

val incoming: <ERROR CLASS><<ERROR CLASS>>

var maxFrameSize:

val outgoing: <ERROR CLASS><<ERROR CLASS>>

fun terminate():

-class DummyWsSessionModule
-

Module Contents

DummyWsSessionModule()

fun configure():

DummyWebSocketSession()

open fun close():

open fun close(status: <ERROR CLASS>):

open fun getAcceptedProtocol():

?

open fun getAttributes():

<

,

>

open fun getBinaryMessageSizeLimit():

open fun getExtensions():

<

<ERROR CLASS>

>

open fun getHandshakeHeaders(): <ERROR CLASS>

open fun getId():

open fun getLocalAddress():

InetSocketAddress

?

open fun getPrincipal():

?

open fun getRemoteAddress():

InetSocketAddress

?

open fun getTextMessageSizeLimit():

open fun getUri():

?

open fun isOpen():

open fun sendMessage(message: <ERROR CLASS><out <ERROR CLASS>>):

open fun setBinaryMessageSizeLimit(messageSizeLimit:

)

:

open fun setTextMessageSizeLimit(messageSizeLimit:

)

:

@@ -22481,6 +22442,7 @@ +const val KV_ROUTE_ID_ATTRIBUTE: String
open class KVController

KVServiceManager(serviceClass:

<

>

)

fun addRoute(method: HttpMethod, path:

,

handler

:

suspend

<ERROR CLASS>

<

,

<ERROR CLASS>

>

.

(

)

->

)

:

fun addRoute(method: HttpMethod, path:

,

handler

:

(

<ERROR CLASS>

,

<ERROR CLASS>

,

<ERROR CLASS>

)

->

)

:

protected actual inline fun <reified RET> bind(noinline function: suspend

.

(

)

->

,

method

:

HttpMethod

,

route

:

?

)

:

protected actual inline fun <reified PAR, reified RET> bind(noinline function: suspend

.

(

)

->

,

method

:

HttpMethod

,

route

:

?

)

:

protected actual inline fun <reified PAR1, reified PAR2, reified RET> bind(noinline function: suspend

.

(

,

)

->

,

method

:

HttpMethod

,

route

:

?

)

:

protected actual inline fun <reified PAR1, reified PAR2, reified PAR3, reified PAR4, reified PAR5, reified RET> bind(noinline function: suspend

.

(

,

,

,

,

)

->

,

method

:

HttpMethod

,

route

:

?

)

:

protected actual fun bind(function:

.

(

?

,

?

)

->

<

<ERROR CLASS>

>

)

:

protected actual inline fun <reified PAR1 :

,

reified

PAR2

:

>

bind

(

noinline

function

:

suspend

.

(

<ERROR CLASS>

<

>

,

<ERROR CLASS>

<

>

)

->

,

route

:

?

)

:

fun call(method: HttpMethod, path:

,

handler

:

(

<ERROR CLASS>

,

<ERROR CLASS>

)

->

)

:

<ERROR CLASS>

.

(

)

->

protected val calls:

<

,

<

,

HttpMethod

>

>

val deleteRequests:

<

,

suspend

<ERROR CLASS>

<

,

<ERROR CLASS>

>

.

(

)

->

>

fun getCalls():

<

,

<

,

HttpMethod

>

>

protected inline fun <reified T> getParameter(str:

?

)

:

val getRequests:

<

,

suspend

<ERROR CLASS>

<

,

<ERROR CLASS>

>

.

(

)

->

>

val LOG: <ERROR CLASS>

val mapper: <ERROR CLASS>

<

<ERROR CLASS>

.

(

)

->

>

val serviceClass:

<

>

val webSocketRequests:

<

,

suspend

<ERROR CLASS>

.

(

)

->

>

val webSocketsRequests:

<

,

suspend

(

<ERROR CLASS>

,

<ERROR CLASS>

,

<ERROR CLASS>

<

>

,

<ERROR CLASS>

<

>

)

->

>

-class LoginService
+open class KVWebSocketConfig

LoginService(loginEndpoint:

)

suspend fun login(:

?

)

:

val loginAgent:

val loginEndpoint:

KVWebSocketConfig()

lateinit var applicationContext: <ERROR CLASS>

open fun registerWebSocketHandlers(registry: <ERROR CLASS>):

open fun routeInterceptor(): <ERROR CLASS>

lateinit var services:

<

KVServiceManager

<

*

>

>

open fun socketHandler(): <ERROR CLASS>

open fun webSocketSession(): <ERROR CLASS>

-class MainModule
+class LoginService

MainModule(application: <ERROR CLASS>)

fun configure():

LoginService(loginEndpoint:

)

suspend fun login(:

?

)

:

val loginAgent:

val loginEndpoint:

@@ -22715,10 +22679,7 @@ -suspend fun <RESP> <ERROR CLASS>.withProfile(block: suspend (Profile) -> RESP): RESP
-suspend fun <RESP> withProfile(block: suspend (Profile) -> RESP): RESP
-fun <ERROR CLASS>.writeJSON(json: String): Unit
-class WsSessionModule
+object WebSocketSessionHolder

WsSessionModule(webSocketSession: <ERROR CLASS>)

fun configure():

var webSocketSession: <ERROR CLASS>

+suspend fun <RESP> <ERROR CLASS>.withProfile(block: suspend (Profile) -> RESP): RESP
+suspend fun <RESP> withProfile(block: suspend (Profile) -> RESP): RESP
-- cgit