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

Class WebSocketRequest

java.lang.Object

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

All Implemented Interfaces:

java.io.Serializable, scala.Equals, scala.Product

public final class WebSocketRequest
extends java.lang.Object
implements scala.Product, java.io.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 and Description
WebSocketRequest(Uri uri, scala.collection.immutable.Seq<HttpHeader> extraHeaders, scala.Option<java.lang.String> subprotocol)

Method Summary

Modifier and Type	Method and Description
static WebSocketRequest	apply(Uri uri, scala.collection.immutable.Seq<HttpHeader> extraHeaders, scala.collection.immutable.Seq<java.lang.String> subprotocols)
scala.collection.immutable.Seq<HttpHeader>	extraHeaders()
static WebSocketRequest	fromTargetUri(Uri uri)
static WebSocketRequest	fromTargetUriString(java.lang.String uriString)
scala.Option<java.lang.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.Product

$init$, productArity, productElement, productElementName, productElementNames, productIterator, productPrefix

Methods inherited from interface scala.Equals

canEqual, equals

Constructor Detail

WebSocketRequest

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

Method Detail

fromTargetUri

public static WebSocketRequest fromTargetUri(Uri uri)

fromTargetUriString

public static WebSocketRequest fromTargetUriString(java.lang.String uriString)

apply

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

uri

public Uri uri()

extraHeaders

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

subprotocol

public scala.Option<java.lang.String> subprotocol()