api/pl.treksoft.kvision.remote/index.html


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187

<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>&nbsp;/&nbsp;<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="-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-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/index.html">RemoteAgent</a></p>
</td>
<td>
<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">RemoteAgent</span><span class="symbol">&lt;</span><span class="keyword">out</span>&nbsp;<span class="identifier">T</span><span class="symbol">&gt;</span></code>
<p>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">open</span> <span class="keyword">expect</span> <span class="keyword">class </span><span class="identifier">ServiceManager</span><span class="symbol">&lt;</span><span class="keyword">out</span>&nbsp;<span class="identifier">T</span><span class="symbol">&gt;</span></code>
<p>Multiplatform service manager.</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>&nbsp;<span class="symbol">:</span>&nbsp;<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>&nbsp;<span class="symbol">=</span>&nbsp;<span class="identifier">&lt;ERROR CLASS&gt;</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="async.html">async</a></p>
</td>
<td>
<code><span class="keyword">fun </span><span class="symbol">&lt;</span><span class="identifier">RESP</span><span class="symbol">&gt;</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>&nbsp;<span class="symbol">(</span><a href="-request.html"><span class="identifier">Request</span></a><span class="symbol">)</span>&nbsp;<span class="symbol">-&gt;</span>&nbsp;<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">&lt;</span><a href="async.html#RESP"><span class="identifier">RESP</span></a><span class="symbol">&gt;</span></code>
<p>A helper extension function for asynchronous request processing.</p>
<code><span class="keyword">fun </span><span class="symbol">&lt;</span><span class="identifier">RESP</span><span class="symbol">&gt;</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.Function2((pl.treksoft.kvision.remote.Request, , pl.treksoft.kvision.remote.async.RESP)))/block">block</span><span class="symbol">:</span>&nbsp;<span class="symbol">(</span><a href="-request.html"><span class="identifier">Request</span></a><span class="symbol">,</span>&nbsp;<span class="identifier">&lt;ERROR CLASS&gt;</span><span class="symbol">)</span>&nbsp;<span class="symbol">-&gt;</span>&nbsp;<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">&lt;</span><a href="async.html#RESP"><span class="identifier">RESP</span></a><span class="symbol">&gt;</span></code>
<p>A helper extension function for asynchronous request processing with session.</p>
<code><span class="keyword">fun </span><span class="symbol">&lt;</span><span class="identifier">RESP</span><span class="symbol">&gt;</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.Function3((pl.treksoft.kvision.remote.Request, , pl.treksoft.kvision.remote.Profile, pl.treksoft.kvision.remote.async.RESP)))/block">block</span><span class="symbol">:</span>&nbsp;<span class="symbol">(</span><a href="-request.html"><span class="identifier">Request</span></a><span class="symbol">,</span>&nbsp;<span class="identifier">&lt;ERROR CLASS&gt;</span><span class="symbol">,</span>&nbsp;<a href="-profile/index.html"><span class="identifier">Profile</span></a><span class="symbol">)</span>&nbsp;<span class="symbol">-&gt;</span>&nbsp;<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">&lt;</span><a href="async.html#RESP"><span class="identifier">RESP</span></a><span class="symbol">&gt;</span></code>
<p>A helper extension function for asynchronous request processing with session and user profile.</p>
</td>
</tr>
</tbody>
</table>
</BODY>
</HTML>