play.mvc

Class WebSocket

java.lang.Object

play.mvc.WebSocket

public abstract class WebSocket
extends java.lang.Object

A WebSocket handler. Migration note - the original WebSocket class was deprecated and renamed to LegacyWebSocket. Existing code that provided implementations of that class can migrate by extending LegacyWebSocket instead.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WebSocket.In<A> Deprecated. Use Akka Streams instead.
static class	WebSocket.MappedWebSocketAcceptor<In,Out> Utility class for creating WebSockets.
static interface	WebSocket.Out<A> Deprecated. Use Akka Streams instead.

Field Summary

Fields

Modifier and Type	Field and Description
static WebSocket.MappedWebSocketAcceptor<akka.util.ByteString,akka.util.ByteString>	Binary Acceptor for binary WebSockets.
static WebSocket.MappedWebSocketAcceptor<com.fasterxml.jackson.databind.JsonNode,com.fasterxml.jackson.databind.JsonNode>	Json Acceptor for JSON WebSockets.
static WebSocket.MappedWebSocketAcceptor<java.lang.String,java.lang.String>	Text Acceptor for text WebSockets.

Constructor Summary

Constructors

Constructor and Description
WebSocket()

Method Summary

Modifier and Type	Method and Description
abstract java.util.concurrent.CompletionStage<F.Either<Result,akka.stream.javadsl.Flow<Message,Message,?>>>	apply(Http.RequestHeader request) Invoke the WebSocket.
static <In,Out> WebSocket.MappedWebSocketAcceptor<In,Out>	json(java.lang.Class<In> in) Acceptor for JSON WebSockets.
static <A> LegacyWebSocket<A>	reject(Result result) Deprecated. Use the WebSocket.accept*OrResult methods instead.
static <A> LegacyWebSocket<A>	whenReady(java.util.function.BiConsumer<WebSocket.In<A>,WebSocket.Out<A>> callback) Deprecated. Use the WebSocket.accept* methods instead.
static <A> LegacyWebSocket<A>	withActor(java.util.function.Function<akka.actor.ActorRef,akka.actor.Props> props) Deprecated. Use the WebSocket.accept* methods instead, with a flow created by wrapping a Sink.actorRef and Source.actorRef.

Methods inherited from class java.lang.Object

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

Field Detail

Text

public static final WebSocket.MappedWebSocketAcceptor<java.lang.String,java.lang.String> Text

Acceptor for text WebSockets.

Binary

public static final WebSocket.MappedWebSocketAcceptor<akka.util.ByteString,akka.util.ByteString> Binary

Acceptor for binary WebSockets.

Json

public static final WebSocket.MappedWebSocketAcceptor<com.fasterxml.jackson.databind.JsonNode,com.fasterxml.jackson.databind.JsonNode> Json

Acceptor for JSON WebSockets.

Constructor Detail

WebSocket

public WebSocket()

Method Detail

apply

public abstract java.util.concurrent.CompletionStage<F.Either<Result,akka.stream.javadsl.Flow<Message,Message,?>>> apply(Http.RequestHeader request)

Invoke the WebSocket.

Parameters:

request - The request for the WebSocket.

Returns:

A future of either a result to reject the WebSocket connection with, or a Flow to handle the WebSocket.

json

public static <In,Out> WebSocket.MappedWebSocketAcceptor<In,Out> json(java.lang.Class<In> in)

Acceptor for JSON WebSockets.

Type Parameters:

In - The websocket's input type (what it receives from clients)

Out - The websocket's output type (what it writes to clients)

Parameters:

in - The class of the incoming messages, used to decode them from the JSON.

Returns:

The WebSocket acceptor.

whenReady

@Deprecated
public static <A> LegacyWebSocket<A> whenReady(java.util.function.BiConsumer<WebSocket.In<A>,WebSocket.Out<A>> callback)

Deprecated. Use the WebSocket.accept* methods instead.

Creates a WebSocket. The abstract onReady method is implemented using the specified BiConsumer<In<A>, Out<A>>

Type Parameters:

A - the in/out type of the legacy websocket

Parameters:

callback - the callback used to implement onReady

Returns:

a new WebSocket

Throws:

java.lang.NullPointerException - if the specified callback is null

reject

@Deprecated
public static <A> LegacyWebSocket<A> reject(Result result)

Deprecated. Use the WebSocket.accept*OrResult methods instead.

Rejects a WebSocket.

Type Parameters:

A - the socket's in/out type

Parameters:

result - The result that will be returned.

Returns:

A rejected WebSocket.

withActor

@Deprecated
public static <A> LegacyWebSocket<A> withActor(java.util.function.Function<akka.actor.ActorRef,akka.actor.Props> props)

Deprecated. Use the WebSocket.accept* methods instead, with a flow created by wrapping a Sink.actorRef and Source.actorRef.

Handles a WebSocket with an actor.

Type Parameters:

A - the socket's in/out type

Parameters:

props - The function used to create the props for the actor. The passed in argument is the upstream actor.

Returns:

An actor WebSocket.