io.nadron.protocols.impl

Class WebSocketProtocol

java.lang.Object

io.nadron.protocols.AbstractNettyProtocol

io.nadron.protocols.impl.WebSocketProtocol

All Implemented Interfaces:

Protocol

public class WebSocketProtocol
extends AbstractNettyProtocol

This protocol can be used for websocket clients which pass JSon objects as text over the wire. The incoming text will be converted to Event objects and sent to the Session. The outgoing messages will be converted from Events to JSon string representation using Jackson library.

Author:

Abraham Menacherry

Field Summary

Fields

Modifier and Type	Field and Description
private static org.slf4j.Logger	LOG
private TextWebsocketDecoder	textWebsocketDecoder Used to decode incoming JSon string objects to Event objects.
private TextWebsocketEncoder	textWebsocketEncoder Used to encode the outgoing Event objects to JSon string representation.

Fields inherited from class io.nadron.protocols.AbstractNettyProtocol

IDLE_STATE_CHECK_HANDLER

Constructor Summary

Constructors

Constructor and Description
WebSocketProtocol()

Method Summary

Methods

Modifier and Type	Method and Description
void	applyProtocol(PlayerSession playerSession) The main method of this interface.
void	applyProtocol(PlayerSession playerSession, boolean clearExistingProtocolHandlers) Specifically overriden so that the pipeline is not cleared.
TextWebsocketDecoder	getTextWebsocketDecoder()
TextWebsocketEncoder	getTextWebsocketEncoder()
void	setTextWebsocketDecoder(TextWebsocketDecoder textWebsocketDecoder)
void	setTextWebsocketEncoder(TextWebsocketEncoder textWebsocketEncoder)

Methods inherited from class io.nadron.protocols.AbstractNettyProtocol

createLengthBasedFrameDecoder, getProtocolName

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final org.slf4j.Logger LOG

textWebsocketDecoder

private TextWebsocketDecoder textWebsocketDecoder

Used to decode incoming JSon string objects to Event objects.

textWebsocketEncoder

private TextWebsocketEncoder textWebsocketEncoder

Used to encode the outgoing Event objects to JSon string representation.

Constructor Detail

WebSocketProtocol

public WebSocketProtocol()

Method Detail

applyProtocol

public void applyProtocol(PlayerSession playerSession,
                 boolean clearExistingProtocolHandlers)

Specifically overriden so that the pipeline is not cleared. TODO check if simply adding wsencoder, wsdecoder in the chain will still maintain the connection.

Specified by:

applyProtocol in interface Protocol

Overrides:

applyProtocol in class AbstractNettyProtocol

clearExistingProtocolHandlers - Clears the pipeline of existing protocol handlers if set to true.

applyProtocol

public void applyProtocol(PlayerSession playerSession)

Description copied from interface: Protocol

The main method of this interface. For the Netty implementation, this will be used to add the handlers in the pipeline associated with this user session. For now, "configuration" only means adding of handlers. It is expected that the LoginHandler or whichever previous handler was handling the message has cleared up the ChannelPipeline object.

Parameters:

playerSession - The user session for which the protocol handlers need to be set.

getTextWebsocketEncoder

public TextWebsocketEncoder getTextWebsocketEncoder()

setTextWebsocketEncoder

public void setTextWebsocketEncoder(TextWebsocketEncoder textWebsocketEncoder)

getTextWebsocketDecoder

public TextWebsocketDecoder getTextWebsocketDecoder()

setTextWebsocketDecoder

public void setTextWebsocketDecoder(TextWebsocketDecoder textWebsocketDecoder)