play.mvc

Class LegacyWebSocket<A>

java.lang.Object

play.mvc.LegacyWebSocket<A>

Deprecated.

Use play.mvc.WebSocket instead.

@Deprecated
public abstract class LegacyWebSocket<A>
extends java.lang.Object

A legacy WebSocket result.

Constructor Summary

Constructors

Constructor and Description
LegacyWebSocket() Deprecated.

Method Summary

Modifier and Type	Method and Description
akka.actor.Props	actorProps(akka.actor.ActorRef out) Deprecated. The props to create the actor to handle this WebSocket.
boolean	isActor() Deprecated. If this method returns true, then the WebSocket should be handled by an actor.
abstract void	onReady(WebSocket.In<A> in, WebSocket.Out<A> out) Deprecated. Called when the WebSocket is ready
Result	rejectWith() Deprecated. If this method returns a result, the WebSocket will be rejected with that result.

Methods inherited from class java.lang.Object

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

Constructor Detail

LegacyWebSocket

public LegacyWebSocket()

Deprecated.

Method Detail

onReady

public abstract void onReady(WebSocket.In<A> in,
                             WebSocket.Out<A> out)

Deprecated.

Called when the WebSocket is ready

Parameters:

in - The Socket in.

out - The Socket out.

rejectWith

public Result rejectWith()

Deprecated.

If this method returns a result, the WebSocket will be rejected with that result. This method will be invoked before onReady.

Returns:

The result to reject the WebSocket with, or null if the WebSocket shouldn't be rejected.

isActor

public boolean isActor()

Deprecated.

If this method returns true, then the WebSocket should be handled by an actor. The actor will be obtained by passing an ActorRef representing to the actor method, which should return the props for creating the actor.

Returns:

true if the websocket should be handled by an actor.

actorProps

public akka.actor.Props actorProps(akka.actor.ActorRef out)

Deprecated.

The props to create the actor to handle this WebSocket.

Parameters:

out - The actor to send upstream messages to.

Returns:

The props of the actor to handle the WebSocket. If isActor returns true, must not return null.