Packages

trait WebSocketUpgrade extends javadsl.model.ws.WebSocketUpgrade

An attribute that will be added to an WebSocket upgrade HttpRequest that enables a request handler to upgrade this connection to a WebSocket connection and registers a WebSocket handler.

This is a low-level API. You might want to use handleWebSocketMessages instead as documented at https://pekko.apache.org/docs/pekko-http/current/server-side/websocket-support.html#routing-support

Source
WebSocketUpgrade.scala
Linear Supertypes
javadsl.model.ws.WebSocketUpgrade, AnyRef, Any
Known Subclasses
UpgradeToWebSocket
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. WebSocketUpgrade
  2. WebSocketUpgrade
  3. AnyRef
  4. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def handleMessages(handlerFlow: Graph[FlowShape[Message, Message], Any], subprotocol: Option[String] = None): HttpResponse

    The high-level interface to create a WebSocket server based on "messages".

    The high-level interface to create a WebSocket server based on "messages".

    Returns a response to return in a request handler that will signal the low-level HTTP implementation to upgrade the connection to WebSocket and use the supplied handler to handle incoming WebSocket messages.

    Optionally, a subprotocol out of the ones requested by the client can be chosen.

  2. abstract def requestedProtocols: Seq[String]

    A sequence of protocols the client accepts.

    A sequence of protocols the client accepts.

    See http://tools.ietf.org/html/rfc6455#section-1.9

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from WebSocketUpgrade toany2stringadd[WebSocketUpgrade] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (WebSocketUpgrade, B)
    Implicit
    This member is added by an implicit conversion from WebSocketUpgrade toArrowAssoc[WebSocketUpgrade] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. def ensuring(cond: (WebSocketUpgrade) => Boolean, msg: => Any): WebSocketUpgrade
    Implicit
    This member is added by an implicit conversion from WebSocketUpgrade toEnsuring[WebSocketUpgrade] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (WebSocketUpgrade) => Boolean): WebSocketUpgrade
    Implicit
    This member is added by an implicit conversion from WebSocketUpgrade toEnsuring[WebSocketUpgrade] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): WebSocketUpgrade
    Implicit
    This member is added by an implicit conversion from WebSocketUpgrade toEnsuring[WebSocketUpgrade] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): WebSocketUpgrade
    Implicit
    This member is added by an implicit conversion from WebSocketUpgrade toEnsuring[WebSocketUpgrade] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. def getRequestedProtocols(): Iterable[String]

    Java API

    Java API

    Definition Classes
    WebSocketUpgrade → WebSocketUpgrade
  17. def handleMessagesWith(inSink: Graph[SinkShape[javadsl.model.ws.Message], _], outSource: Graph[SourceShape[javadsl.model.ws.Message], _], subprotocol: String): HttpResponse

    Java API

    Java API

    Definition Classes
    WebSocketUpgrade → WebSocketUpgrade
  18. def handleMessagesWith(inSink: Graph[SinkShape[javadsl.model.ws.Message], _], outSource: Graph[SourceShape[javadsl.model.ws.Message], _]): HttpResponse

    Java API

    Java API

    Definition Classes
    WebSocketUpgrade → WebSocketUpgrade
  19. def handleMessagesWith(handlerFlow: Graph[FlowShape[javadsl.model.ws.Message, javadsl.model.ws.Message], _], subprotocol: String): HttpResponse

    Java API

    Java API

    Definition Classes
    WebSocketUpgrade → WebSocketUpgrade
  20. def handleMessagesWith(handlerFlow: Graph[FlowShape[javadsl.model.ws.Message, javadsl.model.ws.Message], _]): HttpResponse

    Java API

    Java API

    Definition Classes
    WebSocketUpgrade → WebSocketUpgrade
  21. def handleMessagesWithSinkSource(inSink: Graph[SinkShape[Message], Any], outSource: Graph[SourceShape[Message], Any], subprotocol: Option[String] = None): HttpResponse

    The high-level interface to create a WebSocket server based on "messages".

    The high-level interface to create a WebSocket server based on "messages".

    Returns a response to return in a request handler that will signal the low-level HTTP implementation to upgrade the connection to WebSocket and use the supplied inSink to consume messages received from the client and the supplied outSource to produce message to sent to the client.

    Optionally, a subprotocol out of the ones requested by the client can be chosen.

  22. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  23. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  24. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  26. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  27. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  28. def toString(): String
    Definition Classes
    AnyRef → Any
  29. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  31. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from WebSocketUpgrade toStringFormat[WebSocketUpgrade] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  2. def →[B](y: B): (WebSocketUpgrade, B)
    Implicit
    This member is added by an implicit conversion from WebSocketUpgrade toArrowAssoc[WebSocketUpgrade] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from javadsl.model.ws.WebSocketUpgrade

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromWebSocketUpgrade to any2stringadd[WebSocketUpgrade]

Inherited by implicit conversion StringFormat fromWebSocketUpgrade to StringFormat[WebSocketUpgrade]

Inherited by implicit conversion Ensuring fromWebSocketUpgrade to Ensuring[WebSocketUpgrade]

Inherited by implicit conversion ArrowAssoc fromWebSocketUpgrade to ArrowAssoc[WebSocketUpgrade]

Ungrouped