Class/Object

akka.http.scaladsl.model.ws

WebSocketRequest

Related Docs: object WebSocketRequest | package ws

Permalink

final case class WebSocketRequest(uri: Uri, extraHeaders: Seq[HttpHeader] = Nil, subprotocol: Option[String] = None) extends Product with Serializable

Represents a WebSocket request.

uri

The target URI to connect to.

extraHeaders

Extra headers to add to the WebSocket request.

subprotocol

A WebSocket subprotocol if required.

Source
WebSocketRequest.scala
Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. WebSocketRequest
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new WebSocketRequest(uri: Uri, extraHeaders: Seq[HttpHeader] = Nil, subprotocol: Option[String] = None)

    Permalink

    uri

    The target URI to connect to.

    extraHeaders

    Extra headers to add to the WebSocket request.

    subprotocol

    A WebSocket subprotocol if required.

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from WebSocketRequest to any2stringadd[WebSocketRequest] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd

  4. def ->[B](y: B): (WebSocketRequest, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from WebSocketRequest to ArrowAssoc[WebSocketRequest] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. def ensuring(cond: (WebSocketRequest) ⇒ Boolean, msg: ⇒ Any): WebSocketRequest

    Permalink
    Implicit information
    This member is added by an implicit conversion from WebSocketRequest to Ensuring[WebSocketRequest] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  9. def ensuring(cond: (WebSocketRequest) ⇒ Boolean): WebSocketRequest

    Permalink
    Implicit information
    This member is added by an implicit conversion from WebSocketRequest to Ensuring[WebSocketRequest] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  10. def ensuring(cond: Boolean, msg: ⇒ Any): WebSocketRequest

    Permalink
    Implicit information
    This member is added by an implicit conversion from WebSocketRequest to Ensuring[WebSocketRequest] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  11. def ensuring(cond: Boolean): WebSocketRequest

    Permalink
    Implicit information
    This member is added by an implicit conversion from WebSocketRequest to Ensuring[WebSocketRequest] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  12. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  13. val extraHeaders: Seq[HttpHeader]

    Permalink

    Extra headers to add to the WebSocket request.

  14. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  15. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from WebSocketRequest to StringFormat[WebSocketRequest] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  16. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  17. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  18. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  19. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  20. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  21. val subprotocol: Option[String]

    Permalink

    A WebSocket subprotocol if required.

  22. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  23. val uri: Uri

    Permalink

    The target URI to connect to.

  24. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  25. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  26. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  27. def →[B](y: B): (WebSocketRequest, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from WebSocketRequest to ArrowAssoc[WebSocketRequest] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from WebSocketRequest to any2stringadd[WebSocketRequest]

Inherited by implicit conversion StringFormat from WebSocketRequest to StringFormat[WebSocketRequest]

Inherited by implicit conversion Ensuring from WebSocketRequest to Ensuring[WebSocketRequest]

Inherited by implicit conversion ArrowAssoc from WebSocketRequest to ArrowAssoc[WebSocketRequest]

Ungrouped