Package org.apache.pekko.http.scaladsl.model.ws

Class WebSocketRequest

java.lang.Object

org.apache.pekko.http.scaladsl.model.ws.WebSocketRequest

All Implemented Interfaces:

Serializable, scala.Equals, scala.Product

public final class WebSocketRequest
extends Object
implements scala.Product, Serializable

Represents a WebSocket request. param: uri The target URI to connect to. param: extraHeaders Extra headers to add to the WebSocket request. param: subprotocol WebSocket subprotocols (comma separated) if required.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
WebSocketRequest(Uri uri, scala.collection.immutable.Seq<HttpHeader> extraHeaders, scala.Option<String> subprotocol)

Method Summary

Modifier and Type	Method	Description
static WebSocketRequest	apply(Uri uri, scala.collection.immutable.Seq<HttpHeader> extraHeaders, scala.collection.immutable.Seq<String> subprotocols)
scala.collection.immutable.Seq<HttpHeader>	extraHeaders()
static WebSocketRequest	fromTargetUri(Uri uri)
static WebSocketRequest	fromTargetUriString(String uriString)
scala.Option<String>	subprotocol()
Uri	uri()

Methods inherited from class java.lang.Object

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

Methods inherited from interface scala.Equals

canEqual, equals

Methods inherited from interface scala.Product

productArity, productElement, productElementName, productElementNames, productIterator, productPrefix

Constructor Details

WebSocketRequest

public WebSocketRequest(Uri uri,
 scala.collection.immutable.Seq<HttpHeader> extraHeaders,
 scala.Option<String> subprotocol)

Method Details

fromTargetUri

public static WebSocketRequest fromTargetUri(Uri uri)

fromTargetUriString

public static WebSocketRequest fromTargetUriString(String uriString)

apply

public static WebSocketRequest apply(Uri uri,
 scala.collection.immutable.Seq<HttpHeader> extraHeaders,
 scala.collection.immutable.Seq<String> subprotocols)

uri

public Uri uri()

extraHeaders

public scala.collection.immutable.Seq<HttpHeader> extraHeaders()

subprotocol

public scala.Option<String> subprotocol()