Package akka.http.impl.engine.ws
Class WebSocket$
java.lang.Object
akka.http.impl.engine.ws.WebSocket$
INTERNAL API
Defines components of the websocket stack.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final WebSocket$
Static reference to the singleton instance of this Scala object. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionakka.stream.scaladsl.BidiFlow<FrameEventOrError,
FrameHandler.Output, Object, FrameStart, akka.NotUsed> frameHandling
(boolean serverSide, scala.concurrent.duration.FiniteDuration closeTimeout, akka.event.LoggingAdapter log) The layer that implements all low-level frame handling, like handling control frames, collecting messages from frames, decoding text messages, close handling, etc.akka.stream.scaladsl.BidiFlow<akka.util.ByteString,
FrameEvent, FrameEvent, akka.util.ByteString, akka.NotUsed> framing()
The lowest layer that implements the binary protocolakka.stream.scaladsl.BidiFlow<FrameEvent,
FrameEventOrError, FrameEvent, FrameEvent, akka.NotUsed> The layer that handles masking using the rules defined in the specificationakka.stream.scaladsl.BidiFlow<FrameHandler.Output,
Message, Message, Object, akka.NotUsed> messageAPI
(boolean serverSide, scala.concurrent.duration.FiniteDuration closeTimeout) The layer that provides the high-level user facing API on top of frame handling.akka.stream.scaladsl.BidiFlow<FrameHandler.Output,
FrameHandler.Output, Object, Object, akka.NotUsed> periodicKeepAlive
(WebSocketSettings settings) The layer that transparently injects (if enabled) keepAlive Ping or Pong messages when connection is idleakka.stream.scaladsl.BidiFlow<FrameEvent,
Message, Message, FrameEvent, akka.NotUsed> stack
(boolean serverSide, WebSocketSettings websocketSettings, scala.concurrent.duration.FiniteDuration closeTimeout, akka.event.LoggingAdapter log) A stack of all the higher WS layers between raw frames and the user API.
-
Field Details
-
MODULE$
Static reference to the singleton instance of this Scala object.
-
-
Constructor Details
-
WebSocket$
public WebSocket$()
-
-
Method Details
-
stack
public akka.stream.scaladsl.BidiFlow<FrameEvent,Message, stackMessage, FrameEvent, akka.NotUsed> (boolean serverSide, WebSocketSettings websocketSettings, scala.concurrent.duration.FiniteDuration closeTimeout, akka.event.LoggingAdapter log) A stack of all the higher WS layers between raw frames and the user API.- Parameters:
serverSide
- (undocumented)websocketSettings
- (undocumented)closeTimeout
- (undocumented)log
- (undocumented)- Returns:
- (undocumented)
-
framing
public akka.stream.scaladsl.BidiFlow<akka.util.ByteString,FrameEvent, framing()FrameEvent, akka.util.ByteString, akka.NotUsed> The lowest layer that implements the binary protocol -
masking
public akka.stream.scaladsl.BidiFlow<FrameEvent,FrameEventOrError, maskingFrameEvent, FrameEvent, akka.NotUsed> (boolean serverSide, scala.Function0<Random> maskingRandomFactory) The layer that handles masking using the rules defined in the specification -
periodicKeepAlive
public akka.stream.scaladsl.BidiFlow<FrameHandler.Output,FrameHandler.Output, periodicKeepAliveObject, Object, akka.NotUsed> (WebSocketSettings settings) The layer that transparently injects (if enabled) keepAlive Ping or Pong messages when connection is idle -
frameHandling
public akka.stream.scaladsl.BidiFlow<FrameEventOrError,FrameHandler.Output, frameHandlingObject, FrameStart, akka.NotUsed> (boolean serverSide, scala.concurrent.duration.FiniteDuration closeTimeout, akka.event.LoggingAdapter log) The layer that implements all low-level frame handling, like handling control frames, collecting messages from frames, decoding text messages, close handling, etc.- Parameters:
serverSide
- (undocumented)closeTimeout
- (undocumented)log
- (undocumented)- Returns:
- (undocumented)
-
messageAPI
public akka.stream.scaladsl.BidiFlow<FrameHandler.Output,Message, messageAPIMessage, Object, akka.NotUsed> (boolean serverSide, scala.concurrent.duration.FiniteDuration closeTimeout) The layer that provides the high-level user facing API on top of frame handling.- Parameters:
serverSide
- (undocumented)closeTimeout
- (undocumented)- Returns:
- (undocumented)
-