From fb7ff5b8bf2073a8d7b78011b9edffc830dc63cb Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Sat, 26 Oct 2019 00:17:24 +0200 Subject: API documentation for KVision 2.0.0 --- .../pl.treksoft.kvision.remote/-socket/-init-.html | 15 +++ api1/pl.treksoft.kvision.remote/-socket/close.html | 15 +++ .../-socket/connect.html | 15 +++ api1/pl.treksoft.kvision.remote/-socket/index.html | 104 +++++++++++++++++++++ .../-socket/is-closed.html | 15 +++ .../-socket/receive.html | 15 +++ api1/pl.treksoft.kvision.remote/-socket/send.html | 15 +++ api1/pl.treksoft.kvision.remote/-socket/state.html | 14 +++ 8 files changed, 208 insertions(+) create mode 100644 api1/pl.treksoft.kvision.remote/-socket/-init-.html create mode 100644 api1/pl.treksoft.kvision.remote/-socket/close.html create mode 100644 api1/pl.treksoft.kvision.remote/-socket/connect.html create mode 100644 api1/pl.treksoft.kvision.remote/-socket/index.html create mode 100644 api1/pl.treksoft.kvision.remote/-socket/is-closed.html create mode 100644 api1/pl.treksoft.kvision.remote/-socket/receive.html create mode 100644 api1/pl.treksoft.kvision.remote/-socket/send.html create mode 100644 api1/pl.treksoft.kvision.remote/-socket/state.html (limited to 'api1/pl.treksoft.kvision.remote/-socket') diff --git a/api1/pl.treksoft.kvision.remote/-socket/-init-.html b/api1/pl.treksoft.kvision.remote/-socket/-init-.html new file mode 100644 index 00000000..2e0478a7 --- /dev/null +++ b/api1/pl.treksoft.kvision.remote/-socket/-init-.html @@ -0,0 +1,15 @@ + + + +Socket.<init> - kvision + + + +kvision / pl.treksoft.kvision.remote / Socket / <init>
+
+

<init>

+ +Socket() +

A websocket client implementation.

+ + diff --git a/api1/pl.treksoft.kvision.remote/-socket/close.html b/api1/pl.treksoft.kvision.remote/-socket/close.html new file mode 100644 index 00000000..1e67ef23 --- /dev/null +++ b/api1/pl.treksoft.kvision.remote/-socket/close.html @@ -0,0 +1,15 @@ + + + +Socket.close - kvision + + + +kvision / pl.treksoft.kvision.remote / Socket / close
+
+

close

+ +fun close(code: Short = 1000): Unit +

Close a websocket.

+ + diff --git a/api1/pl.treksoft.kvision.remote/-socket/connect.html b/api1/pl.treksoft.kvision.remote/-socket/connect.html new file mode 100644 index 00000000..550d176d --- /dev/null +++ b/api1/pl.treksoft.kvision.remote/-socket/connect.html @@ -0,0 +1,15 @@ + + + +Socket.connect - kvision + + + +kvision / pl.treksoft.kvision.remote / Socket / connect
+
+

connect

+ +suspend fun connect(url: String, retryDelay: Long = 1000): Unit +

Connect to a websocket.

+ + diff --git a/api1/pl.treksoft.kvision.remote/-socket/index.html b/api1/pl.treksoft.kvision.remote/-socket/index.html new file mode 100644 index 00000000..215e6db9 --- /dev/null +++ b/api1/pl.treksoft.kvision.remote/-socket/index.html @@ -0,0 +1,104 @@ + + + +Socket - kvision + + + +kvision / pl.treksoft.kvision.remote / Socket
+
+

Socket

+class Socket +

A websocket client implementation.

Constructors

+ + + + + + + +

<init>

+Socket() +

A websocket client implementation.

Properties

+ + + + + + + +

state

+val state: Short

Functions

+ + + + + + + + + + + + + + + + + + + + + + + +

+ close +	+`fun close(code: Short = 1000): Unit` + Close a websocket. +
+ connect +	+`suspend fun connect(url: String, retryDelay: Long = 1000): Unit` + Connect to a websocket. +
+ isClosed +	+`fun isClosed(): Boolean` + Returns if a websocket is closed. +
+ receive +	+`suspend fun receive(): String` + Receive a string from a websocket. +
+ send +	+`fun send(obj: String): Unit` + Send string to a websocket. +

Extension Functions

+ + + + + + + +

createInstance

+fun <T> Any?.createInstance(vararg args: dynamic): T +

Helper function for creating JavaScript objects from dynamic constructors.

+ + diff --git a/api1/pl.treksoft.kvision.remote/-socket/is-closed.html b/api1/pl.treksoft.kvision.remote/-socket/is-closed.html new file mode 100644 index 00000000..66a1b37d --- /dev/null +++ b/api1/pl.treksoft.kvision.remote/-socket/is-closed.html @@ -0,0 +1,15 @@ + + + +Socket.isClosed - kvision + + + +kvision / pl.treksoft.kvision.remote / Socket / isClosed
+
+

isClosed

+ +fun isClosed(): Boolean +

Returns if a websocket is closed.

+ + diff --git a/api1/pl.treksoft.kvision.remote/-socket/receive.html b/api1/pl.treksoft.kvision.remote/-socket/receive.html new file mode 100644 index 00000000..f6f43b34 --- /dev/null +++ b/api1/pl.treksoft.kvision.remote/-socket/receive.html @@ -0,0 +1,15 @@ + + + +Socket.receive - kvision + + + +kvision / pl.treksoft.kvision.remote / Socket / receive
+
+

receive

+ +suspend fun receive(): String +

Receive a string from a websocket.

+ + diff --git a/api1/pl.treksoft.kvision.remote/-socket/send.html b/api1/pl.treksoft.kvision.remote/-socket/send.html new file mode 100644 index 00000000..f160ea23 --- /dev/null +++ b/api1/pl.treksoft.kvision.remote/-socket/send.html @@ -0,0 +1,15 @@ + + + +Socket.send - kvision + + + +kvision / pl.treksoft.kvision.remote / Socket / send
+
+

send

+ +fun send(obj: String): Unit +

Send string to a websocket.

+ + diff --git a/api1/pl.treksoft.kvision.remote/-socket/state.html b/api1/pl.treksoft.kvision.remote/-socket/state.html new file mode 100644 index 00000000..4b60c7f4 --- /dev/null +++ b/api1/pl.treksoft.kvision.remote/-socket/state.html @@ -0,0 +1,14 @@ + + + +Socket.state - kvision + + + +kvision / pl.treksoft.kvision.remote / Socket / state
+
+

state

+ +val state: Short + + -- cgit