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

Class UpgradeToWebSocketLowLevel

java.lang.Object

org.apache.pekko.http.javadsl.model.HttpHeader

org.apache.pekko.http.scaladsl.model.HttpHeader

org.apache.pekko.http.javadsl.model.headers.CustomHeader

org.apache.pekko.http.scaladsl.model.headers.CustomHeader

org.apache.pekko.http.impl.engine.server.InternalCustomHeader

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

All Implemented Interfaces:

Renderable, ToStringRenderable, WebSocketUpgrade, WebSocketUpgrade

public abstract class UpgradeToWebSocketLowLevel
extends InternalCustomHeader
implements WebSocketUpgrade

Currently internal API to handle FrameEvents directly.

INTERNAL API

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.pekko.http.scaladsl.model.HttpHeader

HttpHeader.ParsingResult, HttpHeader.ParsingResult$

Constructor Summary

Constructors

Constructor	Description
UpgradeToWebSocketLowLevel()

Method Summary

Modifier and Type	Method	Description
abstract HttpResponse	handleFrames(org.apache.pekko.stream.Graph<org.apache.pekko.stream.FlowShape<FrameEvent,FrameEvent>,Object> handlerFlow, scala.Option<String> subprotocol)	The low-level interface to create WebSocket server based on "frames".
HttpResponse	handleFrames(org.apache.pekko.stream.Graph<org.apache.pekko.stream.FlowShape<FrameEvent,FrameEvent>,Object> handlerFlow, scala.Option<String> subprotocol, boolean compressionEnabled)
HttpResponse	handleFrames(org.apache.pekko.stream.Graph<org.apache.pekko.stream.FlowShape<FrameEvent,FrameEvent>,Object> handlerFlow, scala.Option<String> subprotocol, boolean compressionEnabled, scala.Function1<FrameStart,Object> shouldCompress)	The shouldCompress function is evaluated once for every outbound text or binary message when permessage-deflate was negotiated.

Methods inherited from class org.apache.pekko.http.impl.engine.server.InternalCustomHeader

name, renderInRequests, renderInResponses, value

Methods inherited from class org.apache.pekko.http.scaladsl.model.headers.CustomHeader

lowercaseName, render

Methods inherited from class org.apache.pekko.http.scaladsl.model.HttpHeader

fastFind, is, isNot, parse, unapply, unsafeToString

Methods inherited from class org.apache.pekko.http.javadsl.model.HttpHeader

parse

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.pekko.http.impl.util.ToStringRenderable

toString

Methods inherited from interface org.apache.pekko.http.scaladsl.model.ws.WebSocketUpgrade

createScalaFlow, getRequestedProtocols, handleMessages, handleMessages, handleMessages, handleMessages, handleMessagesWith, handleMessagesWith, handleMessagesWith, handleMessagesWith, handleMessagesWith, handleMessagesWith, handleMessagesWith, handleMessagesWith, handleMessagesWith, handleMessagesWith, handleMessagesWith, handleMessagesWith, handleMessagesWithSinkSource, handleMessagesWithSinkSource, handleMessagesWithSinkSource, handleMessagesWithSinkSource, requestedProtocols

Constructor Details

UpgradeToWebSocketLowLevel

public UpgradeToWebSocketLowLevel()

Method Details

handleFrames

public abstract HttpResponse handleFrames(org.apache.pekko.stream.Graph<org.apache.pekko.stream.FlowShape<FrameEvent,FrameEvent>,Object> handlerFlow,
 scala.Option<String> subprotocol)

The low-level interface to create WebSocket server based on "frames". The user needs to handle control frames manually in this case.

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 frames.

INTERNAL API (for now)

Parameters:

handlerFlow - (undocumented)

subprotocol - (undocumented)

Returns:

(undocumented)

handleFrames

public HttpResponse handleFrames(org.apache.pekko.stream.Graph<org.apache.pekko.stream.FlowShape<FrameEvent,FrameEvent>,Object> handlerFlow,
 scala.Option<String> subprotocol,
 boolean compressionEnabled)

handleFrames

public HttpResponse handleFrames(org.apache.pekko.stream.Graph<org.apache.pekko.stream.FlowShape<FrameEvent,FrameEvent>,Object> handlerFlow,
 scala.Option<String> subprotocol,
 boolean compressionEnabled,
 scala.Function1<FrameStart,Object> shouldCompress)

The shouldCompress function is evaluated once for every outbound text or binary message when permessage-deflate was negotiated. The decision for the initial frame is retained for every continuation frame.

Parameters:

handlerFlow - (undocumented)

subprotocol - (undocumented)

compressionEnabled - (undocumented)

shouldCompress - (undocumented)

Returns:

(undocumented)