-
Notifications
You must be signed in to change notification settings - Fork 1
/
ClientEngine.ClientUpgradeInfo.html
304 lines (304 loc) · 12.7 KB
/
ClientEngine.ClientUpgradeInfo.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
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.2) on Sat Oct 21 15:44:48 UTC 2023 -->
<title>ClientEngine.ClientUpgradeInfo (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="ClientEngine.ClientUpgradeInfo (Tyrus 2.0.5 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":6,"i1":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
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><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ClientEngine.ClientUpgradeInfo.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>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</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>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.glassfish.tyrus.spi</a></div>
<h2 title="Interface ClientEngine.ClientUpgradeInfo" class="title">Interface ClientEngine.ClientUpgradeInfo</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Enclosing interface:</dt>
<dd><a href="ClientEngine.html" title="interface in org.glassfish.tyrus.spi">ClientEngine</a></dd>
</dl>
<hr>
<pre>public static interface <span class="typeNameLabel">ClientEngine.ClientUpgradeInfo</span></pre>
<div class="block">Upgrade process result.
<p>
Provides information about upgrade process. There are three possible states which can be reported:
<ul>
<li><a href="ClientEngine.ClientUpgradeStatus.html#ANOTHER_UPGRADE_REQUEST_REQUIRED"><code>ClientEngine.ClientUpgradeStatus.ANOTHER_UPGRADE_REQUEST_REQUIRED</code></a></li>
<li><a href="ClientEngine.ClientUpgradeStatus.html#UPGRADE_REQUEST_FAILED"><code>ClientEngine.ClientUpgradeStatus.UPGRADE_REQUEST_FAILED</code></a></li>
<li><a href="ClientEngine.ClientUpgradeStatus.html#SUCCESS"><code>ClientEngine.ClientUpgradeStatus.SUCCESS</code></a></li>
</ul>
<p>
When <a href="#getUpgradeStatus()"><code>getUpgradeStatus()</code></a> returns <a href="ClientEngine.ClientUpgradeStatus.html#SUCCESS"><code>ClientEngine.ClientUpgradeStatus.SUCCESS</code></a>, client container can create
<a href="Connection.html" title="interface in org.glassfish.tyrus.spi"><code>Connection</code></a> and start processing read events from the underlying connection and report them to Tyrus
runtime.
<p>
When <a href="#getUpgradeStatus()"><code>getUpgradeStatus()</code></a> returns <a href="ClientEngine.ClientUpgradeStatus.html#UPGRADE_REQUEST_FAILED"><code>ClientEngine.ClientUpgradeStatus.UPGRADE_REQUEST_FAILED</code></a>, client container
HAS TO close all resources related to currently processed <a href="UpgradeResponse.html" title="class in org.glassfish.tyrus.spi"><code>UpgradeResponse</code></a>.
<p>
When <a href="#getUpgradeStatus()"><code>getUpgradeStatus()</code></a> returns <a href="ClientEngine.ClientUpgradeStatus.html#ANOTHER_UPGRADE_REQUEST_REQUIRED"><code>ClientEngine.ClientUpgradeStatus.ANOTHER_UPGRADE_REQUEST_REQUIRED</code></a>, client
container HAS TO close all resources related to currently processed <a href="UpgradeResponse.html" title="class in org.glassfish.tyrus.spi"><code>UpgradeResponse</code></a>, open new TCP
connection and send <a href="UpgradeRequest.html" title="class in org.glassfish.tyrus.spi"><code>UpgradeRequest</code></a> obtained from method <a href="ClientEngine.html#createUpgradeRequest(org.glassfish.tyrus.spi.ClientEngine.TimeoutHandler)"><code>ClientEngine.createUpgradeRequest(TimeoutHandler)</code></a>.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="Connection.html" title="interface in org.glassfish.tyrus.spi">Connection</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createConnection()">createConnection</a></span>()</code></th>
<td class="colLast">
<div class="block">Create new <a href="Connection.html" title="interface in org.glassfish.tyrus.spi"><code>Connection</code></a> when <a href="#getUpgradeStatus()"><code>getUpgradeStatus()</code></a> returns <a href="ClientEngine.ClientUpgradeStatus.html#SUCCESS"><code>ClientEngine.ClientUpgradeStatus.SUCCESS</code></a>.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="ClientEngine.ClientUpgradeStatus.html" title="enum in org.glassfish.tyrus.spi">ClientEngine.ClientUpgradeStatus</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getUpgradeStatus()">getUpgradeStatus</a></span>()</code></th>
<td class="colLast">
<div class="block">Get <a href="ClientEngine.ClientUpgradeStatus.html" title="enum in org.glassfish.tyrus.spi"><code>ClientEngine.ClientUpgradeStatus</code></a>.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="getUpgradeStatus()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUpgradeStatus</h4>
<pre class="methodSignature"><a href="ClientEngine.ClientUpgradeStatus.html" title="enum in org.glassfish.tyrus.spi">ClientEngine.ClientUpgradeStatus</a> getUpgradeStatus()</pre>
<div class="block">Get <a href="ClientEngine.ClientUpgradeStatus.html" title="enum in org.glassfish.tyrus.spi"><code>ClientEngine.ClientUpgradeStatus</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><a href="ClientEngine.ClientUpgradeStatus.html" title="enum in org.glassfish.tyrus.spi"><code>ClientEngine.ClientUpgradeStatus</code></a>.</dd>
</dl>
</li>
</ul>
<a id="createConnection()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>createConnection</h4>
<pre class="methodSignature"><a href="Connection.html" title="interface in org.glassfish.tyrus.spi">Connection</a> createConnection()</pre>
<div class="block">Create new <a href="Connection.html" title="interface in org.glassfish.tyrus.spi"><code>Connection</code></a> when <a href="#getUpgradeStatus()"><code>getUpgradeStatus()</code></a> returns <a href="ClientEngine.ClientUpgradeStatus.html#SUCCESS"><code>ClientEngine.ClientUpgradeStatus.SUCCESS</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>new <a href="Connection.html" title="interface in org.glassfish.tyrus.spi"><code>Connection</code></a> instance or <code>null</code>, when <a href="#getUpgradeStatus()"><code>getUpgradeStatus()</code></a> does not return
<a href="ClientEngine.ClientUpgradeStatus.html" title="enum in org.glassfish.tyrus.spi"><code>ClientEngine.ClientUpgradeStatus</code></a>.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<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><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ClientEngine.ClientUpgradeInfo.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>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</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>