-
Notifications
You must be signed in to change notification settings - Fork 1
/
package-summary.html
483 lines (483 loc) · 19.6 KB
/
package-summary.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
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.2) on Sat Oct 21 15:44:48 UTC 2023 -->
<title>jakarta.websocket (Tyrus 2.0.5 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2023-10-21">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../script.js"></script>
<script type="text/javascript" src="../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../jquery/jquery-3.3.1.js"></script>
<script type="text/javascript" src="../../jquery/jquery-migrate-3.0.1.js"></script>
<script type="text/javascript" src="../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="jakarta.websocket (Tyrus 2.0.5 API)";
}
}
catch(err) {
}
//-->
var pathtoroot = "../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../index.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../allclasses.html">All Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding"> </div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<main role="main">
<div class="header">
<h1 title="Package" class="title">Package jakarta.websocket</h1>
</div>
<div class="contentContainer">
<section role="region"><a id="package.description">
<!-- -->
</a>
<div class="block">This package contains all the Jakartq WebSocket APIs common to both the client and server side.</div>
</section>
<ul class="blockList">
<li class="blockList">
<table class="typeSummary">
<caption><span>Interface Summary</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ClientEndpointConfig.html" title="interface in jakarta.websocket">ClientEndpointConfig</a></th>
<td class="colLast">
<div class="block">The ClientEndpointConfig is a special kind of endpoint configuration object that contains web socket configuration
information specific only to client endpoints.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="CloseReason.CloseCode.html" title="interface in jakarta.websocket">CloseReason.CloseCode</a></th>
<td class="colLast">
<div class="block">A marker interface for the close codes.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Decoder.html" title="interface in jakarta.websocket">Decoder</a></th>
<td class="colLast">
<div class="block">The Decoder interface holds member interfaces that define how a developer can provide the web socket container a way
web socket messages into developer defined custom objects.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Decoder.Binary.html" title="interface in jakarta.websocket">Decoder.Binary</a><T></th>
<td class="colLast">
<div class="block">This interface defines how a custom object (of type T) is decoded from a web socket message in the form of a byte
buffer.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Decoder.BinaryStream.html" title="interface in jakarta.websocket">Decoder.BinaryStream</a><T></th>
<td class="colLast">
<div class="block">This interface defines how a custom object is decoded from a web socket message in the form of a binary stream.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Decoder.Text.html" title="interface in jakarta.websocket">Decoder.Text</a><T></th>
<td class="colLast">
<div class="block">This interface defines how a custom object is decoded from a web socket message in the form of a string.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Decoder.TextStream.html" title="interface in jakarta.websocket">Decoder.TextStream</a><T></th>
<td class="colLast">
<div class="block">This interface defines how a custom object of type T is decoded from a web socket message in the form of a
character stream.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Encoder.html" title="interface in jakarta.websocket">Encoder</a></th>
<td class="colLast">
<div class="block">The Encoder interface defines how developers can provide a way to convert their custom objects into web socket
messages.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Encoder.Binary.html" title="interface in jakarta.websocket">Encoder.Binary</a><T></th>
<td class="colLast">
<div class="block">This interface defines how to provide a way to convert a custom object into a binary message.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Encoder.BinaryStream.html" title="interface in jakarta.websocket">Encoder.BinaryStream</a><T></th>
<td class="colLast">
<div class="block">This interface may be implemented by encoding algorithms that want to write the encoded object to a binary
stream.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Encoder.Text.html" title="interface in jakarta.websocket">Encoder.Text</a><T></th>
<td class="colLast">
<div class="block">This interface defines how to provide a way to convert a custom object into a text message.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Encoder.TextStream.html" title="interface in jakarta.websocket">Encoder.TextStream</a><T></th>
<td class="colLast">
<div class="block">This interface may be implemented by encoding algorithms that want to write the encoded object to a character
stream.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="EndpointConfig.html" title="interface in jakarta.websocket">EndpointConfig</a></th>
<td class="colLast">
<div class="block">The endpoint configuration contains all the information needed during the handshake process for this end point.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Extension.html" title="interface in jakarta.websocket">Extension</a></th>
<td class="colLast">
<div class="block">A simple representation of a websocket extension as a name and map of extension parameters.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Extension.Parameter.html" title="interface in jakarta.websocket">Extension.Parameter</a></th>
<td class="colLast">
<div class="block">This member interface defines a single websocket extension parameter.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="HandshakeResponse.html" title="interface in jakarta.websocket">HandshakeResponse</a></th>
<td class="colLast">
<div class="block">The handshake response represents the WebSocket-defined HTTP response that is the response to the opening handshake
request.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="MessageHandler.html" title="interface in jakarta.websocket">MessageHandler</a></th>
<td class="colLast">
<div class="block">Developers implement MessageHandlers in order to receive incoming messages during a web socket conversation.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="MessageHandler.Partial.html" title="interface in jakarta.websocket">MessageHandler.Partial</a><T></th>
<td class="colLast">
<div class="block">This kind of handler is notified by the implementation as it becomes ready to deliver parts of a whole message.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="MessageHandler.Whole.html" title="interface in jakarta.websocket">MessageHandler.Whole</a><T></th>
<td class="colLast">
<div class="block">This kind of handler is notified by the container on arrival of a complete message.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="PongMessage.html" title="interface in jakarta.websocket">PongMessage</a></th>
<td class="colLast">
<div class="block">The PongMessage interface represents a web socket pong.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="RemoteEndpoint.html" title="interface in jakarta.websocket">RemoteEndpoint</a></th>
<td class="colLast">
<div class="block">The RemoteEndpoint object is supplied by the container and represents the 'other end' or peer of the Web Socket
conversation.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="RemoteEndpoint.Async.html" title="interface in jakarta.websocket">RemoteEndpoint.Async</a></th>
<td class="colLast">
<div class="block">This representation of the peer of a web socket conversation has the ability to send messages asynchronously.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="RemoteEndpoint.Basic.html" title="interface in jakarta.websocket">RemoteEndpoint.Basic</a></th>
<td class="colLast">
<div class="block">This representation of the peer of a web socket conversation has the ability to send messages synchronously.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="SendHandler.html" title="interface in jakarta.websocket">SendHandler</a></th>
<td class="colLast">
<div class="block">A simple callback object for asynchronous sending of web socket messages.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Session.html" title="interface in jakarta.websocket">Session</a></th>
<td class="colLast">
<div class="block">A Web Socket session represents a conversation between two web socket endpoints.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="WebSocketContainer.html" title="interface in jakarta.websocket">WebSocketContainer</a></th>
<td class="colLast">
<div class="block">A WebSocketContainer is an implementation provided object that provides applications a view on the container running
it.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary">
<caption><span>Class Summary</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ClientEndpointConfig.Builder.html" title="class in jakarta.websocket">ClientEndpointConfig.Builder</a></th>
<td class="colLast">
<div class="block">The ClientEndpointConfig.Builder is a class used for creating <a href="ClientEndpointConfig.html" title="interface in jakarta.websocket"><code>ClientEndpointConfig</code></a> objects for the
purposes of deploying a client endpoint.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ClientEndpointConfig.Configurator.html" title="class in jakarta.websocket">ClientEndpointConfig.Configurator</a></th>
<td class="colLast">
<div class="block">The Configurator class may be extended by developers who want to provide custom configuration algorithms, such as
intercepting the opening handshake, or providing arbitrary methods and algorithms that can be accessed from each
endpoint instance configured with this configurator.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="CloseReason.html" title="class in jakarta.websocket">CloseReason</a></th>
<td class="colLast">
<div class="block">A class encapsulating the reason why a web socket has been closed, or why it is being asked to close.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ContainerProvider.html" title="class in jakarta.websocket">ContainerProvider</a></th>
<td class="colLast">
<div class="block">Provider class that allows the developer to get a reference to the implementation of the WebSocketContainer.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Endpoint.html" title="class in jakarta.websocket">Endpoint</a></th>
<td class="colLast">
<div class="block">The Web Socket Endpoint represents an object that can handle websocket conversations.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="SendResult.html" title="class in jakarta.websocket">SendResult</a></th>
<td class="colLast">
<div class="block">The result of asynchronously sending a web socket message.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary">
<caption><span>Enum Summary</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Enum</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="CloseReason.CloseCodes.html" title="enum in jakarta.websocket">CloseReason.CloseCodes</a></th>
<td class="colLast">
<div class="block">An Enumeration of status codes for a web socket close that are defined in the specification.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary">
<caption><span>Exception Summary</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Exception</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="DecodeException.html" title="class in jakarta.websocket">DecodeException</a></th>
<td class="colLast">
<div class="block">A general exception that occurs when trying to decode a custom object from a text or binary message.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="DeploymentException.html" title="class in jakarta.websocket">DeploymentException</a></th>
<td class="colLast">
<div class="block">Checked exception indicating some kind of failure either to publish an endpoint on its server, or a failure to
connect a client to its server.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="EncodeException.html" title="class in jakarta.websocket">EncodeException</a></th>
<td class="colLast">
<div class="block">A general exception that occurs when trying to encode a custom object to a string or binary message.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="SessionException.html" title="class in jakarta.websocket">SessionException</a></th>
<td class="colLast">
<div class="block">A SessionException represents a general exception type reporting problems occurring on a websocket session.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary">
<caption><span>Annotation Types Summary</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Annotation Type</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ClientEndpoint.html" title="annotation in jakarta.websocket">ClientEndpoint</a></th>
<td class="colLast">
<div class="block">The ClientEndpoint annotation a class level annotation is used to denote that a POJO is a web socket client and can
be deployed as such.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="OnClose.html" title="annotation in jakarta.websocket">OnClose</a></th>
<td class="colLast">
<div class="block">This method level annotation can be used to decorate a Java method that wishes to be called when a web socket session
is closing.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="OnError.html" title="annotation in jakarta.websocket">OnError</a></th>
<td class="colLast">
<div class="block">This method level annotation can be used to decorate a Java method that wishes to be called in order to handle
errors.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="OnMessage.html" title="annotation in jakarta.websocket">OnMessage</a></th>
<td class="colLast">
<div class="block">This method level annotation can be used to make a Java method receive incoming web socket messages.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="OnOpen.html" title="annotation in jakarta.websocket">OnOpen</a></th>
<td class="colLast">
<div class="block">This method level annotation can be used to decorate a Java method that wishes to be called when a new web socket
session is open.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
</main>
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../index.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../allclasses.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright © 2012–2020 <a href="http://www.oracle.com/">Oracle Corporation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>