diff options
Diffstat (limited to 'api/pl.treksoft.kvision.remote/index.html')
| -rw-r--r-- | api/pl.treksoft.kvision.remote/index.html | 267 |
1 files changed, 267 insertions, 0 deletions
diff --git a/api/pl.treksoft.kvision.remote/index.html b/api/pl.treksoft.kvision.remote/index.html new file mode 100644 index 00000000..1917d011 --- /dev/null +++ b/api/pl.treksoft.kvision.remote/index.html @@ -0,0 +1,267 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>pl.treksoft.kvision.remote - 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><br/> +<br/> +<h2>Package pl.treksoft.kvision.remote</h2> +<p>A set of components for creating multiplatform automatic JSON-RPC connectivity with a backend server.</p> +<h3>Types</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="-call-agent/index.html">CallAgent</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">CallAgent</span></code> +<p>An agent responsible for remote calls.</p> +</td> +</tr> +<tr> +<td> +<p><a href="-credentials/index.html">Credentials</a></p> +</td> +<td> +<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">Credentials</span></code> +<p>Username and password credentials.</p> +</td> +</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> +</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> +</tr> +<tr> +<td> +<p><a href="-jooby-service-manager/index.html">JoobyServiceManager</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> +</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> +</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> +</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> +</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> +</td> +</tr> +<tr> +<td> +<p><a href="-login-service/index.html">LoginService</a></p> +</td> +<td> +<code><span class="keyword">class </span><span class="identifier">LoginService</span></code> +<p>Pac4j form login dispatcher.</p> +</td> +</tr> +<tr> +<td> +<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> +<p>A user profile.</p> +</td> +</tr> +<tr> +<td> +<p><a href="-remote-agent.html">RemoteAgent</a></p> +</td> +<td> +<code><span class="keyword">interface </span><span class="identifier">RemoteAgent</span></code> +<p>Interface for client side agent for JSON-RPC remote calls.</p> +</td> +</tr> +<tr> +<td> +<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> +</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> +<code><span class="keyword">abstract</span> <span class="keyword">class </span><span class="identifier">SecurityMgr</span></code> +<p>Pac4j form login dispatcher.</p> +</td> +</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> +<table> +<tbody> +<tr> +<td> +<p><a href="-security-exception/index.html">SecurityException</a></p> +</td> +<td> +<code><span class="keyword">class </span><span class="identifier">SecurityException</span> <span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html"><span class="identifier">Exception</span></a></code> +<p>A security exception.</p> +</td> +</tr> +</tbody> +</table> +<h3>Type Aliases</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="-profile/index.html">Profile</a></p> +</td> +<td> +<code><span class="keyword">actual</span> <span class="keyword">typealias </span><span class="identifier">Profile</span> <span class="symbol">=</span> <span class="identifier"><ERROR CLASS></span></code> +<p>A user profile.</p> +</td> +</tr> +</tbody> +</table> +<h3>Properties</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="-h-t-t-p_-u-n-a-u-t-h-o-r-i-z-e-d.html">HTTP_UNAUTHORIZED</a></p> +</td> +<td> +<code><span class="keyword">const</span> <span class="keyword">val </span><span class="identifier">HTTP_UNAUTHORIZED</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html"><span class="identifier">Int</span></a></code> +<p>HTTP status unauthorized (401).</p> +</td> +</tr> +</tbody> +</table> +<h3>Functions</h3> +<table> +<tbody> +<tr> +<td> +<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> +</tr> +<tr> +<td> +<p><a href="async-session.html">asyncSession</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> +</td> +</tr> +<tr> +<td> +<p><a href="write-j-s-o-n.html">writeJSON</a></p> +</td> +<td> +<code><span class="keyword">fun </span><span class="identifier"><ERROR CLASS></span><span class="symbol">.</span><span class="identifier">writeJSON</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.remote$writeJSON(, kotlin.String)/json">json</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></td> +</tr> +</tbody> +</table> +</BODY> +</HTML> |