Package org.eclipse.jetty.websocket.client

Class WebSocketUpgradeRequest

java.lang.Object

org.eclipse.jetty.client.HttpRequest

org.eclipse.jetty.websocket.client.WebSocketUpgradeRequest

All Implemented Interfaces:

java.util.EventListener, Request, Response.CompleteListener, Response.ResponseListener, HttpConnectionUpgrader

public class WebSocketUpgradeRequest
extends HttpRequest
implements Response.CompleteListener, HttpConnectionUpgrader

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.jetty.client.api.Request

Request.BeginListener, Request.CommitListener, Request.ContentListener, Request.FailureListener, Request.HeadersListener, Request.Listener, Request.QueuedListener, Request.RequestListener, Request.SuccessListener

Constructor Summary

Constructors

Modifier	Constructor	Description
	WebSocketUpgradeRequest(WebSocketClient wsClient, HttpClient httpClient, java.net.URI wsURI, java.lang.Object localEndpoint)	Initiating a WebSocket Upgrade using HTTP/1.1
protected	WebSocketUpgradeRequest(WebSocketClient wsClient, HttpClient httpClient, ClientUpgradeRequest request)	Exists for internal use of HttpClient by WebSocketClient.

Method Summary

Modifier and Type	Method	Description
void	onComplete(Result result)
ContentResponse	send()
void	send(Response.CompleteListener listener)
java.util.concurrent.CompletableFuture<org.eclipse.jetty.websocket.api.Session>	sendAsync()
void	setUpgradeListener(UpgradeListener upgradeListener)
void	upgrade(HttpResponse response, HttpConnectionOverHTTP oldConn)

Methods inherited from class org.eclipse.jetty.client.HttpRequest

abort, accept, agent, attribute, content, content, cookie, file, file, followRedirects, getAbortCause, getAgent, getAttributes, getContent, getConversation, getCookies, getHeaders, getHost, getIdleTimeout, getMethod, getParams, getPath, getPort, getPushListener, getQuery, getRequestListeners, getResponseListeners, getScheme, getTag, getTimeout, getTrailers, getURI, getVersion, header, header, host, idleTimeout, isFollowRedirects, listener, method, method, onComplete, onRequestBegin, onRequestCommit, onRequestContent, onRequestFailure, onRequestHeaders, onRequestQueued, onRequestSuccess, onResponseBegin, onResponseContent, onResponseContentAsync, onResponseContentDemanded, onResponseFailure, onResponseHeader, onResponseHeaders, onResponseSuccess, param, path, port, pushListener, scheme, tag, timeout, toString, trailers, version

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

WebSocketUpgradeRequest

protected WebSocketUpgradeRequest(WebSocketClient wsClient,
                                  HttpClient httpClient,
                                  ClientUpgradeRequest request)

Exists for internal use of HttpClient by WebSocketClient.

Maintained for Backward compatibility and also for JSR356 WebSocket ClientContainer use.

Parameters:

wsClient - the WebSocketClient that this request uses

httpClient - the HttpClient that this request uses

request - the ClientUpgradeRequest (backward compat) to base this request from

WebSocketUpgradeRequest

public WebSocketUpgradeRequest(WebSocketClient wsClient,
                               HttpClient httpClient,
                               java.net.URI wsURI,
                               java.lang.Object localEndpoint)

Initiating a WebSocket Upgrade using HTTP/1.1

Parameters:

wsClient - the WebSocketClient that this request uses

httpClient - the HttpClient that this request uses

localEndpoint - the local endpoint (following Jetty WebSocket Client API rules) to use for incoming WebSocket events

wsURI - the WebSocket URI to connect to

Method Detail

onComplete

public void onComplete(Result result)

Specified by:

onComplete in interface Response.CompleteListener

send

public ContentResponse send()
                     throws java.lang.InterruptedException,
                            java.util.concurrent.TimeoutException,
                            java.util.concurrent.ExecutionException

Specified by:

send in interface Request

Overrides:

send in class HttpRequest

Throws:

java.lang.InterruptedException

java.util.concurrent.TimeoutException

java.util.concurrent.ExecutionException

send

public void send(Response.CompleteListener listener)

Specified by:

send in interface Request

Overrides:

send in class HttpRequest

sendAsync

public java.util.concurrent.CompletableFuture<org.eclipse.jetty.websocket.api.Session> sendAsync()

upgrade

public void upgrade(HttpResponse response,
                    HttpConnectionOverHTTP oldConn)

Specified by:

upgrade in interface HttpConnectionUpgrader

setUpgradeListener

public void setUpgradeListener(UpgradeListener upgradeListener)