org.apache.pekko.http.impl.engine.ws

Class WebSocket$

java.lang.Object

org.apache.pekko.http.impl.engine.ws.WebSocket$

public class WebSocket$
extends java.lang.Object

INTERNAL API

Defines components of the websocket stack.

Field Summary

Fields

Modifier and Type	Field and Description
static WebSocket$	MODULE$ Static reference to the singleton instance of this Scala object.

Constructor Summary

Constructors

Constructor and Description
WebSocket$()

Method Summary

Modifier and Type	Method and Description
org.apache.pekko.stream.scaladsl.BidiFlow<FrameEventOrError,FrameHandler.Output,java.lang.Object,FrameStart,org.apache.pekko.NotUsed>	frameHandling(boolean serverSide, scala.concurrent.duration.FiniteDuration closeTimeout, org.apache.pekko.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.
org.apache.pekko.stream.scaladsl.BidiFlow<org.apache.pekko.util.ByteString,FrameEvent,FrameEvent,org.apache.pekko.util.ByteString,org.apache.pekko.NotUsed>	framing() The lowest layer that implements the binary protocol
org.apache.pekko.stream.scaladsl.BidiFlow<FrameEvent,FrameEventOrError,FrameEvent,FrameEvent,org.apache.pekko.NotUsed>	masking(boolean serverSide, scala.Function0<java.util.Random> maskingRandomFactory) The layer that handles masking using the rules defined in the specification
org.apache.pekko.stream.scaladsl.BidiFlow<FrameHandler.Output,Message,Message,java.lang.Object,org.apache.pekko.NotUsed>	messageAPI(boolean serverSide, scala.concurrent.duration.FiniteDuration closeTimeout) The layer that provides the high-level user facing API on top of frame handling.
org.apache.pekko.stream.scaladsl.BidiFlow<FrameHandler.Output,FrameHandler.Output,java.lang.Object,java.lang.Object,org.apache.pekko.NotUsed>	periodicKeepAlive(WebSocketSettings settings) The layer that transparently injects (if enabled) keepAlive Ping or Pong messages when connection is idle
org.apache.pekko.stream.scaladsl.BidiFlow<FrameEvent,Message,Message,FrameEvent,org.apache.pekko.NotUsed>	stack(boolean serverSide, WebSocketSettings websocketSettings, scala.concurrent.duration.FiniteDuration closeTimeout, org.apache.pekko.event.LoggingAdapter log) A stack of all the higher WS layers between raw frames and the user API.

Methods inherited from class java.lang.Object

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

Field Detail

MODULE$

public static final WebSocket$ MODULE$

Static reference to the singleton instance of this Scala object.

Constructor Detail

WebSocket$

public WebSocket$()

Method Detail

stack

public org.apache.pekko.stream.scaladsl.BidiFlow<FrameEvent,Message,Message,FrameEvent,org.apache.pekko.NotUsed> stack(boolean serverSide,
                                                                                                                       WebSocketSettings websocketSettings,
                                                                                                                       scala.concurrent.duration.FiniteDuration closeTimeout,
                                                                                                                       org.apache.pekko.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 org.apache.pekko.stream.scaladsl.BidiFlow<org.apache.pekko.util.ByteString,FrameEvent,FrameEvent,org.apache.pekko.util.ByteString,org.apache.pekko.NotUsed> framing()

The lowest layer that implements the binary protocol

masking

public org.apache.pekko.stream.scaladsl.BidiFlow<FrameEvent,FrameEventOrError,FrameEvent,FrameEvent,org.apache.pekko.NotUsed> masking(boolean serverSide,
                                                                                                                                      scala.Function0<java.util.Random> maskingRandomFactory)

The layer that handles masking using the rules defined in the specification

periodicKeepAlive

public org.apache.pekko.stream.scaladsl.BidiFlow<FrameHandler.Output,FrameHandler.Output,java.lang.Object,java.lang.Object,org.apache.pekko.NotUsed> periodicKeepAlive(WebSocketSettings settings)

The layer that transparently injects (if enabled) keepAlive Ping or Pong messages when connection is idle

frameHandling

public org.apache.pekko.stream.scaladsl.BidiFlow<FrameEventOrError,FrameHandler.Output,java.lang.Object,FrameStart,org.apache.pekko.NotUsed> frameHandling(boolean serverSide,
                                                                                                                                                           scala.concurrent.duration.FiniteDuration closeTimeout,
                                                                                                                                                           org.apache.pekko.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 org.apache.pekko.stream.scaladsl.BidiFlow<FrameHandler.Output,Message,Message,java.lang.Object,org.apache.pekko.NotUsed> messageAPI(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)