diff options
| author | Robert Jaros <rjaros@finn.pl> | 2019-04-04 13:10:28 +0200 |
|---|---|---|
| committer | Robert Jaros <rjaros@finn.pl> | 2019-04-04 13:10:28 +0200 |
| commit | 8883419bfcec00947863741d48dbd89cc877615a (patch) | |
| tree | 3bfaa51ceaae33abe2be84d1bcc6c772bec2fd59 /api/pl.treksoft.kvision.remote/-socket/index.html | |
| parent | 7d18a562b285a7ae08f81ba6110637ea797e84f9 (diff) | |
| download | kvision-8883419bfcec00947863741d48dbd89cc877615a.tar.gz kvision-8883419bfcec00947863741d48dbd89cc877615a.tar.bz2 kvision-8883419bfcec00947863741d48dbd89cc877615a.zip | |
API documentation for KVision 0.0.32
Diffstat (limited to 'api/pl.treksoft.kvision.remote/-socket/index.html')
| -rw-r--r-- | api/pl.treksoft.kvision.remote/-socket/index.html | 104 |
1 files changed, 104 insertions, 0 deletions
diff --git a/api/pl.treksoft.kvision.remote/-socket/index.html b/api/pl.treksoft.kvision.remote/-socket/index.html new file mode 100644 index 00000000..215e6db9 --- /dev/null +++ b/api/pl.treksoft.kvision.remote/-socket/index.html @@ -0,0 +1,104 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>Socket - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.remote</a> / <a href="./index.html">Socket</a><br/> +<br/> +<h1>Socket</h1> +<code><span class="keyword">class </span><span class="identifier">Socket</span></code> +<p>A websocket client implementation.</p> +<h3>Constructors</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="-init-.html"><init></a></p> +</td> +<td> +<code><span class="identifier">Socket</span><span class="symbol">(</span><span class="symbol">)</span></code> +<p>A websocket client implementation.</p> +</td> +</tr> +</tbody> +</table> +<h3>Properties</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="state.html">state</a></p> +</td> +<td> +<code><span class="keyword">val </span><span class="identifier">state</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-short/index.html"><span class="identifier">Short</span></a></code></td> +</tr> +</tbody> +</table> +<h3>Functions</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="close.html">close</a></p> +</td> +<td> +<code><span class="keyword">fun </span><span class="identifier">close</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.remote.Socket$close(kotlin.Short)/code">code</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-short/index.html"><span class="identifier">Short</span></a> <span class="symbol">=</span> 1000<span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code> +<p>Close a websocket.</p> +</td> +</tr> +<tr> +<td> +<p><a href="connect.html">connect</a></p> +</td> +<td> +<code><span class="keyword">suspend</span> <span class="keyword">fun </span><span class="identifier">connect</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.remote.Socket$connect(kotlin.String, kotlin.Long)/url">url</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.remote.Socket$connect(kotlin.String, kotlin.Long)/retryDelay">retryDelay</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html"><span class="identifier">Long</span></a> <span class="symbol">=</span> 1000<span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code> +<p>Connect to a websocket.</p> +</td> +</tr> +<tr> +<td> +<p><a href="is-closed.html">isClosed</a></p> +</td> +<td> +<code><span class="keyword">fun </span><span class="identifier">isClosed</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a></code> +<p>Returns if a websocket is closed.</p> +</td> +</tr> +<tr> +<td> +<p><a href="receive.html">receive</a></p> +</td> +<td> +<code><span class="keyword">suspend</span> <span class="keyword">fun </span><span class="identifier">receive</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a></code> +<p>Receive a string from a websocket.</p> +</td> +</tr> +<tr> +<td> +<p><a href="send.html">send</a></p> +</td> +<td> +<code><span class="keyword">fun </span><span class="identifier">send</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.remote.Socket$send(kotlin.String)/obj">obj</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code> +<p>Send string to a websocket.</p> +</td> +</tr> +</tbody> +</table> +<h3>Extension Functions</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.utils/kotlin.-any/create-instance.html">createInstance</a></p> +</td> +<td> +<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html"><span class="identifier">Any</span></a><span class="symbol">?</span><span class="symbol">.</span><span class="identifier">createInstance</span><span class="symbol">(</span><span class="keyword">vararg</span> <span class="identifier" id="pl.treksoft.kvision.utils$createInstance(kotlin.Any, kotlin.Array((kotlin.Any)))/args">args</span><span class="symbol">:</span> <span class="keyword">dynamic</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../pl.treksoft.kvision.utils/kotlin.-any/create-instance.html#T"><span class="identifier">T</span></a></code> +<p>Helper function for creating JavaScript objects from dynamic constructors.</p> +</td> +</tr> +</tbody> +</table> +</BODY> +</HTML> |