diff options
author | Robert Jaros <rjaros@finn.pl> | 2018-12-23 01:32:27 +0100 |
---|---|---|
committer | Robert Jaros <rjaros@finn.pl> | 2018-12-23 01:32:27 +0100 |
commit | a81c549e277d1a07e87cf8e2eecf89662deda323 (patch) | |
tree | fd64e2f453094f7106bf97faa2833136e58327d4 /api/pl.treksoft.kvision.remote/index.html | |
parent | cc229b215e07fa84d48c5754cdb6ba26fd678910 (diff) | |
download | kvision-a81c549e277d1a07e87cf8e2eecf89662deda323.tar.gz kvision-a81c549e277d1a07e87cf8e2eecf89662deda323.tar.bz2 kvision-a81c549e277d1a07e87cf8e2eecf89662deda323.zip |
API documentation for KVision 0.0.22
Diffstat (limited to 'api/pl.treksoft.kvision.remote/index.html')
-rw-r--r-- | api/pl.treksoft.kvision.remote/index.html | 114 |
1 files changed, 21 insertions, 93 deletions
diff --git a/api/pl.treksoft.kvision.remote/index.html b/api/pl.treksoft.kvision.remote/index.html index 1917d011..a2620d5a 100644 --- a/api/pl.treksoft.kvision.remote/index.html +++ b/api/pl.treksoft.kvision.remote/index.html @@ -32,57 +32,37 @@ </tr> <tr> <td> -<p><a href="-http-method/index.html">HttpMethod</a></p> -</td> -<td> -<code><span class="keyword">enum</span> <span class="keyword">class </span><span class="identifier">HttpMethod</span></code></td> -</tr> -<tr> -<td> -<p><a href="-jooby-remote-agent/index.html">JoobyRemoteAgent</a></p> +<p><a href="-k-v-controller/index.html">KVController</a></p> </td> <td> -<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">JoobyRemoteAgent</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> <a href="-remote-agent.html"><span class="identifier">RemoteAgent</span></a></code> -<p>Client side agent for JSON-RPC remote calls with Jooby.</p> -</td> +<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">KVController</span></code></td> </tr> <tr> <td> -<p><a href="-jooby-service-manager/index.html">JoobyServiceManager</a></p> +<p><a href="-k-v-remote-agent/index.html">KVRemoteAgent</a></p> </td> <td> -<code><span class="keyword">open</span> <span class="keyword">expect</span> <span class="keyword">class </span><span class="identifier">JoobyServiceManager</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> <a href="-service-manager/index.html"><span class="identifier">ServiceManager</span></a></code> -<p>Multiplatform service manager for Jooby.</p> +<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">KVRemoteAgent</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> <a href="-remote-agent.html"><span class="identifier">RemoteAgent</span></a></code> +<p>Client side agent for JSON-RPC remote calls.</p> </td> </tr> <tr> <td> -<p><a href="-json-rpc-request/index.html">JsonRpcRequest</a></p> -</td> -<td> -<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">JsonRpcRequest</span></code></td> -</tr> -<tr> -<td> -<p><a href="-json-rpc-response/index.html">JsonRpcResponse</a></p> +<p><a href="-k-v-server/index.html">KVServer</a></p> </td> <td> -<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">JsonRpcResponse</span></code></td> -</tr> -<tr> -<td> -<p><a href="-k-v-controller/index.html">KVController</a></p> +<code><span class="keyword">open</span> <span class="keyword">actual</span> <span class="keyword">class </span><span class="identifier">KVServer</span></code> +<p>A server. +Not used on the js platform.</p> </td> -<td> -<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">KVController</span></code></td> </tr> <tr> <td> -<p><a href="-k-v-server/index.html">KVServer</a></p> +<p><a href="-k-v-service-manager/index.html">KVServiceManager</a></p> </td> <td> -<code><span class="keyword">open</span> <span class="keyword">expect</span> <span class="keyword">class </span><span class="identifier">KVServer</span></code> -<p>A server.</p> +<code><span class="keyword">open</span> <span class="keyword">actual</span> <span class="keyword">class </span><span class="identifier">KVServiceManager</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></code> +<p>Multiplatform service manager.</p> </td> </tr> <tr> @@ -99,7 +79,7 @@ <p><a href="-profile/index.html">Profile</a></p> </td> <td> -<code><span class="keyword">expect</span> <span class="keyword">class </span><span class="identifier">Profile</span></code> +<code><span class="keyword">data</span> <span class="keyword">actual</span> <span class="keyword">class </span><span class="identifier">Profile</span></code> <p>A user profile.</p> </td> </tr> @@ -117,19 +97,13 @@ <p><a href="-request.html">Request</a></p> </td> <td> -<code><span class="keyword">expect</span> <span class="keyword">interface </span><span class="identifier">Request</span></code> -<p>A server request.</p> +<code><span class="keyword">actual</span> <span class="keyword">interface </span><span class="identifier">Request</span></code> +<p>A server request. +Not used on the js platform.</p> </td> </tr> <tr> <td> -<p><a href="-rpc-http-method/index.html">RpcHttpMethod</a></p> -</td> -<td> -<code><span class="keyword">enum</span> <span class="keyword">class </span><span class="identifier">RpcHttpMethod</span></code></td> -</tr> -<tr> -<td> <p><a href="-security-mgr/index.html">SecurityMgr</a></p> </td> <td> @@ -139,36 +113,11 @@ </tr> <tr> <td> -<p><a href="-service-manager/index.html">ServiceManager</a></p> -</td> -<td> -<code><span class="keyword">interface </span><span class="identifier">ServiceManager</span></code></td> -</tr> -<tr> -<td> <p><a href="-spring-context/index.html">SpringContext</a></p> </td> <td> <code><span class="keyword">class </span><span class="identifier">SpringContext</span></code></td> </tr> -<tr> -<td> -<p><a href="-spring-remote-agent/index.html">SpringRemoteAgent</a></p> -</td> -<td> -<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">SpringRemoteAgent</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> <a href="-remote-agent.html"><span class="identifier">RemoteAgent</span></a></code> -<p>Client side agent for JSON-RPC remote calls with Spring Boot.</p> -</td> -</tr> -<tr> -<td> -<p><a href="-spring-service-manager/index.html">SpringServiceManager</a></p> -</td> -<td> -<code><span class="keyword">open</span> <span class="keyword">expect</span> <span class="keyword">class </span><span class="identifier">SpringServiceManager</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> <a href="-service-manager/index.html"><span class="identifier">ServiceManager</span></a></code> -<p>Multiplatform service manager for Spring Boot.</p> -</td> -</tr> </tbody> </table> <h3>Exceptions</h3> @@ -221,37 +170,16 @@ <p><a href="add-path-patterns-from-services.html">addPathPatternsFromServices</a></p> </td> <td> -<code><span class="keyword">fun </span><span class="identifier"><ERROR CLASS></span><span class="symbol">.</span><span class="identifier">addPathPatternsFromServices</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.remote$addPathPatternsFromServices(, kotlin.collections.List((pl.treksoft.kvision.remote.SpringServiceManager((kotlin.Any)))))/services">services</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html"><span class="identifier">List</span></a><span class="symbol"><</span><a href="-spring-service-manager/index.html"><span class="identifier">SpringServiceManager</span></a><span class="symbol"><</span><span class="identifier">*</span><span class="symbol">></span><span class="symbol">></span><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></td> -</tr> -<tr> -<td> -<p><a href="async.html">async</a></p> -</td> -<td> -<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">RESP</span><span class="symbol">></span> <a href="-request.html"><span class="identifier">Request</span></a><span class="symbol">?</span><span class="symbol">.</span><span class="identifier">async</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.remote$async(pl.treksoft.kvision.remote.Request, kotlin.Function1((pl.treksoft.kvision.remote.Request, pl.treksoft.kvision.remote.async.RESP)))/block">block</span><span class="symbol">:</span> <span class="symbol">(</span><a href="-request.html"><span class="identifier">Request</span></a><span class="symbol">)</span> <span class="symbol">-></span> <a href="async.html#RESP"><span class="identifier">RESP</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Deferred</span><span class="symbol"><</span><a href="async.html#RESP"><span class="identifier">RESP</span></a><span class="symbol">></span></code> -<p>A helper extension function for asynchronous request processing.</p> -<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">RESP</span><span class="symbol">></span> <span class="identifier">async</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.remote$async(kotlin.Function0((pl.treksoft.kvision.remote.async.RESP)))/block">block</span><span class="symbol">:</span> <span class="symbol">(</span><span class="symbol">)</span> <span class="symbol">-></span> <a href="async.html#RESP"><span class="identifier">RESP</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Deferred</span><span class="symbol"><</span><a href="async.html#RESP"><span class="identifier">RESP</span></a><span class="symbol">></span></code> -<p>A helper extension function for asynchronous processing.</p> -</td> -</tr> -<tr> -<td> -<p><a href="async-auth.html">asyncAuth</a></p> -</td> -<td> -<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">RESP</span><span class="symbol">></span> <a href="-request.html"><span class="identifier">Request</span></a><span class="symbol">?</span><span class="symbol">.</span><span class="identifier">asyncAuth</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.remote$asyncAuth(pl.treksoft.kvision.remote.Request, kotlin.Function3((pl.treksoft.kvision.remote.Request, , pl.treksoft.kvision.remote.Profile, pl.treksoft.kvision.remote.asyncAuth.RESP)))/block">block</span><span class="symbol">:</span> <span class="symbol">(</span><a href="-request.html"><span class="identifier">Request</span></a><span class="symbol">,</span> <span class="identifier"><ERROR CLASS></span><span class="symbol">,</span> <a href="-profile/index.html"><span class="identifier">Profile</span></a><span class="symbol">)</span> <span class="symbol">-></span> <a href="async-auth.html#RESP"><span class="identifier">RESP</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Deferred</span><span class="symbol"><</span><a href="async-auth.html#RESP"><span class="identifier">RESP</span></a><span class="symbol">></span></code> -<p>A helper extension function for asynchronous request processing with session and user profile.</p> -<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">RESP</span><span class="symbol">></span> <span class="identifier">asyncAuth</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.remote$asyncAuth(kotlin.Function1((pl.treksoft.kvision.remote.Profile, pl.treksoft.kvision.remote.asyncAuth.RESP)))/block">block</span><span class="symbol">:</span> <span class="symbol">(</span><a href="-profile/index.html"><span class="identifier">Profile</span></a><span class="symbol">)</span> <span class="symbol">-></span> <a href="async-auth.html#RESP"><span class="identifier">RESP</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Deferred</span><span class="symbol"><</span><a href="async-auth.html#RESP"><span class="identifier">RESP</span></a><span class="symbol">></span></code> -<p>A helper extension function for asynchronous processing with user profile.</p> -</td> +<code><span class="keyword">fun </span><span class="identifier"><ERROR CLASS></span><span class="symbol">.</span><span class="identifier">addPathPatternsFromServices</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.remote$addPathPatternsFromServices(, kotlin.collections.List((pl.treksoft.kvision.remote.KVServiceManager((kotlin.Any)))))/services">services</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html"><span class="identifier">List</span></a><span class="symbol"><</span><a href="-k-v-service-manager/index.html"><span class="identifier">KVServiceManager</span></a><span class="symbol"><</span><span class="identifier">*</span><span class="symbol">></span><span class="symbol">></span><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></td> </tr> <tr> <td> -<p><a href="async-session.html">asyncSession</a></p> +<p><a href="with-profile.html">withProfile</a></p> </td> <td> -<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">RESP</span><span class="symbol">></span> <a href="-request.html"><span class="identifier">Request</span></a><span class="symbol">?</span><span class="symbol">.</span><span class="identifier">asyncSession</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.remote$asyncSession(pl.treksoft.kvision.remote.Request, kotlin.Function2((pl.treksoft.kvision.remote.Request, , pl.treksoft.kvision.remote.asyncSession.RESP)))/block">block</span><span class="symbol">:</span> <span class="symbol">(</span><a href="-request.html"><span class="identifier">Request</span></a><span class="symbol">,</span> <span class="identifier"><ERROR CLASS></span><span class="symbol">)</span> <span class="symbol">-></span> <a href="async-session.html#RESP"><span class="identifier">RESP</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Deferred</span><span class="symbol"><</span><a href="async-session.html#RESP"><span class="identifier">RESP</span></a><span class="symbol">></span></code> -<p>A helper extension function for asynchronous request processing with session.</p> +<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">RESP</span><span class="symbol">></span> <a href="-request.html"><span class="identifier">Request</span></a><span class="symbol">.</span><span class="identifier">withProfile</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.remote$withProfile(pl.treksoft.kvision.remote.Request, kotlin.Function1((pl.treksoft.kvision.remote.Profile, pl.treksoft.kvision.remote.withProfile.RESP)))/block">block</span><span class="symbol">:</span> <span class="symbol">(</span><a href="-profile/index.html"><span class="identifier">Profile</span></a><span class="symbol">)</span> <span class="symbol">-></span> <a href="with-profile.html#RESP"><span class="identifier">RESP</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="with-profile.html#RESP"><span class="identifier">RESP</span></a></code><br/> +<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">RESP</span><span class="symbol">></span> <span class="identifier">withProfile</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.remote$withProfile(kotlin.Function1((pl.treksoft.kvision.remote.Profile, pl.treksoft.kvision.remote.withProfile.RESP)))/block">block</span><span class="symbol">:</span> <span class="symbol">(</span><a href="-profile/index.html"><span class="identifier">Profile</span></a><span class="symbol">)</span> <span class="symbol">-></span> <a href="with-profile.html#RESP"><span class="identifier">RESP</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="with-profile.html#RESP"><span class="identifier">RESP</span></a></code> +<p>A helper extension function for processing with authenticated user profile.</p> </td> </tr> <tr> |