Package akka.http.impl.engine.ws
Class UpgradeToWebSocketLowLevel
- java.lang.Object
-
- akka.http.javadsl.model.HttpHeader
-
- akka.http.scaladsl.model.HttpHeader
-
- akka.http.javadsl.model.headers.CustomHeader
-
- akka.http.scaladsl.model.headers.CustomHeader
-
- akka.http.impl.engine.server.InternalCustomHeader
-
- akka.http.impl.engine.ws.UpgradeToWebSocketLowLevel
-
- All Implemented Interfaces:
Renderable
,ToStringRenderable
,UpgradeToWebSocket
,WebSocketUpgrade
,UpgradeToWebSocket
,WebSocketUpgrade
public abstract class UpgradeToWebSocketLowLevel extends InternalCustomHeader implements UpgradeToWebSocket, WebSocketUpgrade
Currently internal API to handle FrameEvents directly.INTERNAL API
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class akka.http.scaladsl.model.HttpHeader
HttpHeader.ParsingResult, HttpHeader.ParsingResult$
-
-
Constructor Summary
Constructors Constructor Description UpgradeToWebSocketLowLevel()
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description abstract HttpResponse
handleFrames(akka.stream.Graph<akka.stream.FlowShape<FrameEvent,FrameEvent>,java.lang.Object> handlerFlow, scala.Option<java.lang.String> subprotocol)
The low-level interface to create WebSocket server based on "frames".-
Methods inherited from class akka.http.impl.engine.server.InternalCustomHeader
name, renderInRequests, renderInResponses, value
-
Methods inherited from class akka.http.scaladsl.model.headers.CustomHeader
lowercaseName, render
-
Methods inherited from class akka.http.scaladsl.model.HttpHeader
fastFind, is, isNot, parse, unapply, unsafeToString
-
Methods inherited from class akka.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 akka.http.impl.util.ToStringRenderable
toString
-
Methods inherited from interface akka.http.scaladsl.model.ws.UpgradeToWebSocket
createScalaFlow, getRequestedProtocols, handleMessages, handleMessagesWith, handleMessagesWith, handleMessagesWith, handleMessagesWith, handleMessagesWithSinkSource, requestedProtocols
-
Methods inherited from interface akka.http.scaladsl.model.ws.WebSocketUpgrade
getRequestedProtocols, handleMessagesWith, handleMessagesWith, handleMessagesWith, handleMessagesWith
-
-
-
-
Method Detail
-
handleFrames
public abstract HttpResponse handleFrames(akka.stream.Graph<akka.stream.FlowShape<FrameEvent,FrameEvent>,java.lang.Object> handlerFlow, scala.Option<java.lang.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)
-
-