| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.7) on Fri Jun 12 14:11:40 EDT 2020 --> |
| <title>WebSocketUpgradeRequest (Jetty :: Project 9.4.30.v20200611 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2020-06-12"> |
| <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="WebSocketUpgradeRequest (Jetty :: Project 9.4.30.v20200611 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../../"; |
| var useModuleDirectories = false; |
| 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/WebSocketUpgradeRequest.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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.eclipse.jetty.websocket.client</a></div> |
| <h2 title="Class WebSocketUpgradeRequest" class="title">Class WebSocketUpgradeRequest</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../client/HttpRequest.html" title="class in org.eclipse.jetty.client">org.eclipse.jetty.client.HttpRequest</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.eclipse.jetty.websocket.client.WebSocketUpgradeRequest</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code>java.util.EventListener</code>, <code><a href="../../client/api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code>, <code><a href="../../client/api/Response.CompleteListener.html" title="interface in org.eclipse.jetty.client.api">Response.CompleteListener</a></code>, <code><a href="../../client/api/Response.ResponseListener.html" title="interface in org.eclipse.jetty.client.api">Response.ResponseListener</a></code>, <code><a href="../../client/http/HttpConnectionUpgrader.html" title="interface in org.eclipse.jetty.client.http">HttpConnectionUpgrader</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public class <span class="typeNameLabel">WebSocketUpgradeRequest</span> |
| extends <a href="../../client/HttpRequest.html" title="class in org.eclipse.jetty.client">HttpRequest</a> |
| implements <a href="../../client/api/Response.CompleteListener.html" title="interface in org.eclipse.jetty.client.api">Response.CompleteListener</a>, <a href="../../client/http/HttpConnectionUpgrader.html" title="interface in org.eclipse.jetty.client.http">HttpConnectionUpgrader</a></pre> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.classes.inherited.from.class.org.eclipse.jetty.client.api.Request"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface org.eclipse.jetty.client.api.<a href="../../client/api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></h3> |
| <code><a href="../../client/api/Request.BeginListener.html" title="interface in org.eclipse.jetty.client.api">Request.BeginListener</a>, <a href="../../client/api/Request.CommitListener.html" title="interface in org.eclipse.jetty.client.api">Request.CommitListener</a>, <a href="../../client/api/Request.ContentListener.html" title="interface in org.eclipse.jetty.client.api">Request.ContentListener</a>, <a href="../../client/api/Request.FailureListener.html" title="interface in org.eclipse.jetty.client.api">Request.FailureListener</a>, <a href="../../client/api/Request.HeadersListener.html" title="interface in org.eclipse.jetty.client.api">Request.HeadersListener</a>, <a href="../../client/api/Request.Listener.html" title="interface in org.eclipse.jetty.client.api">Request.Listener</a>, <a href="../../client/api/Request.QueuedListener.html" title="interface in org.eclipse.jetty.client.api">Request.QueuedListener</a>, <a href="../../client/api/Request.RequestListener.html" title="interface in org.eclipse.jetty.client.api">Request.RequestListener</a>, <a href="../../client/api/Request.SuccessListener.html" title="interface in org.eclipse.jetty.client.api">Request.SuccessListener</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier</th> |
| <th class="colSecond" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code> </code></td> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.eclipse.jetty.websocket.client.WebSocketClient,org.eclipse.jetty.client.HttpClient,java.net.URI,java.lang.Object)">WebSocketUpgradeRequest</a></span>​(<a href="WebSocketClient.html" title="class in org.eclipse.jetty.websocket.client">WebSocketClient</a> wsClient, |
| <a href="../../client/HttpClient.html" title="class in org.eclipse.jetty.client">HttpClient</a> httpClient, |
| java.net.URI wsURI, |
| java.lang.Object localEndpoint)</code></th> |
| <td class="colLast"> |
| <div class="block">Initiating a WebSocket Upgrade using HTTP/1.1</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected </code></td> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.eclipse.jetty.websocket.client.WebSocketClient,org.eclipse.jetty.client.HttpClient,org.eclipse.jetty.websocket.client.ClientUpgradeRequest)">WebSocketUpgradeRequest</a></span>​(<a href="WebSocketClient.html" title="class in org.eclipse.jetty.websocket.client">WebSocketClient</a> wsClient, |
| <a href="../../client/HttpClient.html" title="class in org.eclipse.jetty.client">HttpClient</a> httpClient, |
| <a href="ClientUpgradeRequest.html" title="class in org.eclipse.jetty.websocket.client">ClientUpgradeRequest</a> request)</code></th> |
| <td class="colLast"> |
| <div class="block">Exists for internal use of HttpClient by WebSocketClient.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== 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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onComplete(org.eclipse.jetty.client.api.Result)">onComplete</a></span>​(<a href="../../client/api/Result.html" title="class in org.eclipse.jetty.client.api">Result</a> result)</code></th> |
| <td class="colLast"> |
| <div class="block">Callback method invoked when the request <em><b>and</b></em> the response have been processed, |
| either successfully or not.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../client/api/ContentResponse.html" title="interface in org.eclipse.jetty.client.api">ContentResponse</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#send()">send</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Sends this request and returns the response.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#send(org.eclipse.jetty.client.api.Response.CompleteListener)">send</a></span>​(<a href="../../client/api/Response.CompleteListener.html" title="interface in org.eclipse.jetty.client.api">Response.CompleteListener</a> listener)</code></th> |
| <td class="colLast"> |
| <div class="block">Sends this request and asynchronously notifies the given listener for response events.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>java.util.concurrent.CompletableFuture<<a href="../api/Session.html" title="interface in org.eclipse.jetty.websocket.api">Session</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sendAsync()">sendAsync</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setUpgradeListener(org.eclipse.jetty.websocket.client.io.UpgradeListener)">setUpgradeListener</a></span>​(<a href="io/UpgradeListener.html" title="interface in org.eclipse.jetty.websocket.client.io">UpgradeListener</a> upgradeListener)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#upgrade(org.eclipse.jetty.client.HttpResponse,org.eclipse.jetty.client.http.HttpConnectionOverHTTP)">upgrade</a></span>​(<a href="../../client/HttpResponse.html" title="class in org.eclipse.jetty.client">HttpResponse</a> response, |
| <a href="../../client/http/HttpConnectionOverHTTP.html" title="class in org.eclipse.jetty.client.http">HttpConnectionOverHTTP</a> oldConn)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.client.HttpRequest"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.eclipse.jetty.client.<a href="../../client/HttpRequest.html" title="class in org.eclipse.jetty.client">HttpRequest</a></h3> |
| <code><a href="../../client/HttpRequest.html#abort(java.lang.Throwable)">abort</a>, <a href="../../client/HttpRequest.html#accept(java.lang.String...)">accept</a>, <a href="../../client/HttpRequest.html#agent(java.lang.String)">agent</a>, <a href="../../client/HttpRequest.html#attribute(java.lang.String,java.lang.Object)">attribute</a>, <a href="../../client/HttpRequest.html#content(org.eclipse.jetty.client.api.ContentProvider)">content</a>, <a href="../../client/HttpRequest.html#content(org.eclipse.jetty.client.api.ContentProvider,java.lang.String)">content</a>, <a href="../../client/HttpRequest.html#cookie(java.net.HttpCookie)">cookie</a>, <a href="../../client/HttpRequest.html#file(java.nio.file.Path)">file</a>, <a href="../../client/HttpRequest.html#file(java.nio.file.Path,java.lang.String)">file</a>, <a href="../../client/HttpRequest.html#followRedirects(boolean)">followRedirects</a>, <a href="../../client/HttpRequest.html#getAbortCause()">getAbortCause</a>, <a href="../../client/HttpRequest.html#getAgent()">getAgent</a>, <a href="../../client/HttpRequest.html#getAttributes()">getAttributes</a>, <a href="../../client/HttpRequest.html#getContent()">getContent</a>, <a href="../../client/HttpRequest.html#getConversation()">getConversation</a>, <a href="../../client/HttpRequest.html#getCookies()">getCookies</a>, <a href="../../client/HttpRequest.html#getHeaders()">getHeaders</a>, <a href="../../client/HttpRequest.html#getHost()">getHost</a>, <a href="../../client/HttpRequest.html#getIdleTimeout()">getIdleTimeout</a>, <a href="../../client/HttpRequest.html#getMethod()">getMethod</a>, <a href="../../client/HttpRequest.html#getParams()">getParams</a>, <a href="../../client/HttpRequest.html#getPath()">getPath</a>, <a href="../../client/HttpRequest.html#getPort()">getPort</a>, <a href="../../client/HttpRequest.html#getPushListener()">getPushListener</a>, <a href="../../client/HttpRequest.html#getQuery()">getQuery</a>, <a href="../../client/HttpRequest.html#getRequestListeners(java.lang.Class)">getRequestListeners</a>, <a href="../../client/HttpRequest.html#getResponseListeners()">getResponseListeners</a>, <a href="../../client/HttpRequest.html#getScheme()">getScheme</a>, <a href="../../client/HttpRequest.html#getTag()">getTag</a>, <a href="../../client/HttpRequest.html#getTimeout()">getTimeout</a>, <a href="../../client/HttpRequest.html#getTrailers()">getTrailers</a>, <a href="../../client/HttpRequest.html#getURI()">getURI</a>, <a href="../../client/HttpRequest.html#getVersion()">getVersion</a>, <a href="../../client/HttpRequest.html#header(java.lang.String,java.lang.String)">header</a>, <a href="../../client/HttpRequest.html#header(org.eclipse.jetty.http.HttpHeader,java.lang.String)">header</a>, <a href="../../client/HttpRequest.html#host(java.lang.String)">host</a>, <a href="../../client/HttpRequest.html#idleTimeout(long,java.util.concurrent.TimeUnit)">idleTimeout</a>, <a href="../../client/HttpRequest.html#isFollowRedirects()">isFollowRedirects</a>, <a href="../../client/HttpRequest.html#listener(org.eclipse.jetty.client.api.Request.Listener)">listener</a>, <a href="../../client/HttpRequest.html#method(java.lang.String)">method</a>, <a href="../../client/HttpRequest.html#method(org.eclipse.jetty.http.HttpMethod)">method</a>, <a href="../../client/HttpRequest.html#onComplete(org.eclipse.jetty.client.api.Response.CompleteListener)">onComplete</a>, <a href="../../client/HttpRequest.html#onRequestBegin(org.eclipse.jetty.client.api.Request.BeginListener)">onRequestBegin</a>, <a href="../../client/HttpRequest.html#onRequestCommit(org.eclipse.jetty.client.api.Request.CommitListener)">onRequestCommit</a>, <a href="../../client/HttpRequest.html#onRequestContent(org.eclipse.jetty.client.api.Request.ContentListener)">onRequestContent</a>, <a href="../../client/HttpRequest.html#onRequestFailure(org.eclipse.jetty.client.api.Request.FailureListener)">onRequestFailure</a>, <a href="../../client/HttpRequest.html#onRequestHeaders(org.eclipse.jetty.client.api.Request.HeadersListener)">onRequestHeaders</a>, <a href="../../client/HttpRequest.html#onRequestQueued(org.eclipse.jetty.client.api.Request.QueuedListener)">onRequestQueued</a>, <a href="../../client/HttpRequest.html#onRequestSuccess(org.eclipse.jetty.client.api.Request.SuccessListener)">onRequestSuccess</a>, <a href="../../client/HttpRequest.html#onResponseBegin(org.eclipse.jetty.client.api.Response.BeginListener)">onResponseBegin</a>, <a href="../../client/HttpRequest.html#onResponseContent(org.eclipse.jetty.client.api.Response.ContentListener)">onResponseContent</a>, <a href="../../client/HttpRequest.html#onResponseContentAsync(org.eclipse.jetty.client.api.Response.AsyncContentListener)">onResponseContentAsync</a>, <a href="../../client/HttpRequest.html#onResponseContentDemanded(org.eclipse.jetty.client.api.Response.DemandedContentListener)">onResponseContentDemanded</a>, <a href="../../client/HttpRequest.html#onResponseFailure(org.eclipse.jetty.client.api.Response.FailureListener)">onResponseFailure</a>, <a href="../../client/HttpRequest.html#onResponseHeader(org.eclipse.jetty.client.api.Response.HeaderListener)">onResponseHeader</a>, <a href="../../client/HttpRequest.html#onResponseHeaders(org.eclipse.jetty.client.api.Response.HeadersListener)">onResponseHeaders</a>, <a href="../../client/HttpRequest.html#onResponseSuccess(org.eclipse.jetty.client.api.Response.SuccessListener)">onResponseSuccess</a>, <a href="../../client/HttpRequest.html#param(java.lang.String,java.lang.String)">param</a>, <a href="../../client/HttpRequest.html#path(java.lang.String)">path</a>, <a href="../../client/HttpRequest.html#port(int)">port</a>, <a href="../../client/HttpRequest.html#pushListener(java.util.function.BiFunction)">pushListener</a>, <a href="../../client/HttpRequest.html#scheme(java.lang.String)">scheme</a>, <a href="../../client/HttpRequest.html#tag(java.lang.Object)">tag</a>, <a href="../../client/HttpRequest.html#timeout(long,java.util.concurrent.TimeUnit)">timeout</a>, <a href="../../client/HttpRequest.html#toString()">toString</a>, <a href="../../client/HttpRequest.html#trailers(java.util.function.Supplier)">trailers</a>, <a href="../../client/HttpRequest.html#version(org.eclipse.jetty.http.HttpVersion)">version</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>(org.eclipse.jetty.websocket.client.WebSocketClient,org.eclipse.jetty.client.HttpClient,org.eclipse.jetty.websocket.client.ClientUpgradeRequest)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>WebSocketUpgradeRequest</h4> |
| <pre>protected WebSocketUpgradeRequest​(<a href="WebSocketClient.html" title="class in org.eclipse.jetty.websocket.client">WebSocketClient</a> wsClient, |
| <a href="../../client/HttpClient.html" title="class in org.eclipse.jetty.client">HttpClient</a> httpClient, |
| <a href="ClientUpgradeRequest.html" title="class in org.eclipse.jetty.websocket.client">ClientUpgradeRequest</a> request)</pre> |
| <div class="block">Exists for internal use of HttpClient by WebSocketClient. |
| <p> |
| Maintained for Backward compatibility and also for JSR356 WebSocket ClientContainer use.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>wsClient</code> - the WebSocketClient that this request uses</dd> |
| <dd><code>httpClient</code> - the HttpClient that this request uses</dd> |
| <dd><code>request</code> - the ClientUpgradeRequest (backward compat) to base this request from</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="<init>(org.eclipse.jetty.websocket.client.WebSocketClient,org.eclipse.jetty.client.HttpClient,java.net.URI,java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>WebSocketUpgradeRequest</h4> |
| <pre>public WebSocketUpgradeRequest​(<a href="WebSocketClient.html" title="class in org.eclipse.jetty.websocket.client">WebSocketClient</a> wsClient, |
| <a href="../../client/HttpClient.html" title="class in org.eclipse.jetty.client">HttpClient</a> httpClient, |
| java.net.URI wsURI, |
| java.lang.Object localEndpoint)</pre> |
| <div class="block">Initiating a WebSocket Upgrade using HTTP/1.1</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>wsClient</code> - the WebSocketClient that this request uses</dd> |
| <dd><code>httpClient</code> - the HttpClient that this request uses</dd> |
| <dd><code>localEndpoint</code> - the local endpoint (following Jetty WebSocket Client API rules) to use for incoming |
| WebSocket events</dd> |
| <dd><code>wsURI</code> - the WebSocket URI to connect to</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="onComplete(org.eclipse.jetty.client.api.Result)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onComplete</h4> |
| <pre class="methodSignature">public void onComplete​(<a href="../../client/api/Result.html" title="class in org.eclipse.jetty.client.api">Result</a> result)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../client/api/Response.CompleteListener.html#onComplete(org.eclipse.jetty.client.api.Result)">Response.CompleteListener</a></code></span></div> |
| <div class="block">Callback method invoked when the request <em><b>and</b></em> the response have been processed, |
| either successfully or not. |
| <p> |
| The <code>result</code> parameter contains the request, the response, and eventual failures. |
| <p> |
| Requests may complete <em>after</em> response, for example in case of big uploads that are |
| discarded or read asynchronously by the server. |
| This method is always invoked <em>after</em> <a href="../../client/api/Response.SuccessListener.html#onSuccess(org.eclipse.jetty.client.api.Response)"><code>Response.SuccessListener.onSuccess(Response)</code></a> or |
| <a href="../../client/api/Response.FailureListener.html#onFailure(org.eclipse.jetty.client.api.Response,java.lang.Throwable)"><code>Response.FailureListener.onFailure(Response, Throwable)</code></a>, and only when request indicates that |
| it is completed.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../client/api/Response.CompleteListener.html#onComplete(org.eclipse.jetty.client.api.Result)">onComplete</a></code> in interface <code><a href="../../client/api/Response.CompleteListener.html" title="interface in org.eclipse.jetty.client.api">Response.CompleteListener</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>result</code> - the result of the request / response exchange</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="send()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>send</h4> |
| <pre class="methodSignature">public <a href="../../client/api/ContentResponse.html" title="interface in org.eclipse.jetty.client.api">ContentResponse</a> send() |
| throws java.lang.InterruptedException, |
| java.util.concurrent.TimeoutException, |
| java.util.concurrent.ExecutionException</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../client/api/Request.html#send()">Request</a></code></span></div> |
| <div class="block">Sends this request and returns the response. |
| <p> |
| This method should be used when a simple blocking semantic is needed, and when it is known |
| that the response content can be buffered without exceeding memory constraints. |
| <p> |
| For example, this method is not appropriate to download big files from a server; consider using |
| <a href="../../client/api/Request.html#send(org.eclipse.jetty.client.api.Response.CompleteListener)"><code>Request.send(Response.CompleteListener)</code></a> instead, passing your own <a href="../../client/api/Response.Listener.html" title="interface in org.eclipse.jetty.client.api"><code>Response.Listener</code></a> or a utility |
| listener such as <a href="../../client/util/InputStreamResponseListener.html" title="class in org.eclipse.jetty.client.util"><code>InputStreamResponseListener</code></a>. |
| <p> |
| The method returns when the <a href="../../client/api/Response.CompleteListener.html" title="interface in org.eclipse.jetty.client.api"><code>complete event</code></a> is fired.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../client/api/Request.html#send()">send</a></code> in interface <code><a href="../../client/api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../client/HttpRequest.html#send()">send</a></code> in class <code><a href="../../client/HttpRequest.html" title="class in org.eclipse.jetty.client">HttpRequest</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <a href="../../client/api/ContentResponse.html" title="interface in org.eclipse.jetty.client.api"><code>ContentResponse</code></a> for this request</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.InterruptedException</code> - if send thread is interrupted</dd> |
| <dd><code>java.util.concurrent.TimeoutException</code> - if send times out</dd> |
| <dd><code>java.util.concurrent.ExecutionException</code> - if execution fails</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../client/api/Response.CompleteListener.html#onComplete(org.eclipse.jetty.client.api.Result)"><code>Response.CompleteListener.onComplete(Result)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="send(org.eclipse.jetty.client.api.Response.CompleteListener)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>send</h4> |
| <pre class="methodSignature">public void send​(<a href="../../client/api/Response.CompleteListener.html" title="interface in org.eclipse.jetty.client.api">Response.CompleteListener</a> listener)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../client/api/Request.html#send(org.eclipse.jetty.client.api.Response.CompleteListener)">Request</a></code></span></div> |
| <div class="block"><p>Sends this request and asynchronously notifies the given listener for response events.</p> |
| <p>This method should be used when the application needs to be notified of the various response events |
| as they happen, or when the application needs to efficiently manage the response content.</p> |
| <p>The listener passed to this method may implement not only <a href="../../client/api/Response.CompleteListener.html" title="interface in org.eclipse.jetty.client.api"><code>Response.CompleteListener</code></a> |
| but also other response listener interfaces, and all the events implemented will be notified. |
| This allows application code to write a single listener class to handle all relevant events.</p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../client/api/Request.html#send(org.eclipse.jetty.client.api.Response.CompleteListener)">send</a></code> in interface <code><a href="../../client/api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../client/HttpRequest.html#send(org.eclipse.jetty.client.api.Response.CompleteListener)">send</a></code> in class <code><a href="../../client/HttpRequest.html" title="class in org.eclipse.jetty.client">HttpRequest</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>listener</code> - the listener that receives response events</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="sendAsync()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sendAsync</h4> |
| <pre class="methodSignature">public java.util.concurrent.CompletableFuture<<a href="../api/Session.html" title="interface in org.eclipse.jetty.websocket.api">Session</a>> sendAsync()</pre> |
| </li> |
| </ul> |
| <a id="upgrade(org.eclipse.jetty.client.HttpResponse,org.eclipse.jetty.client.http.HttpConnectionOverHTTP)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>upgrade</h4> |
| <pre class="methodSignature">public void upgrade​(<a href="../../client/HttpResponse.html" title="class in org.eclipse.jetty.client">HttpResponse</a> response, |
| <a href="../../client/http/HttpConnectionOverHTTP.html" title="class in org.eclipse.jetty.client.http">HttpConnectionOverHTTP</a> oldConn)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../client/http/HttpConnectionUpgrader.html#upgrade(org.eclipse.jetty.client.HttpResponse,org.eclipse.jetty.client.http.HttpConnectionOverHTTP)">upgrade</a></code> in interface <code><a href="../../client/http/HttpConnectionUpgrader.html" title="interface in org.eclipse.jetty.client.http">HttpConnectionUpgrader</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setUpgradeListener(org.eclipse.jetty.websocket.client.io.UpgradeListener)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setUpgradeListener</h4> |
| <pre class="methodSignature">public void setUpgradeListener​(<a href="io/UpgradeListener.html" title="interface in org.eclipse.jetty.websocket.client.io">UpgradeListener</a> upgradeListener)</pre> |
| </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/WebSocketUpgradeRequest.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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 © 1995–2020 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
