io.nadron.protocols

Class AbstractNettyProtocol

java.lang.Object

io.nadron.protocols.AbstractNettyProtocol

All Implemented Interfaces:

Protocol

Direct Known Subclasses:

AMF3Protocol, AMF3StringProtocol, ChannelBufferProtocol, MessageBufferProtocol, NettyObjectProtocol, StringProtocol, WebSocketProtocol

public abstract class AbstractNettyProtocol
extends Object
implements Protocol

This abstract class defines common methods across all protocols. Individual protocol classes extend this class.

Author:

Abraham Menacherry

Field Summary

Fields

Modifier and Type	Field and Description
static String	IDLE_STATE_CHECK_HANDLER Name of the idle state check handlers which will be removed by protocol manually if required from pipeline.
(package private) String	protocolName The name of the protocol.

Constructor Summary

Constructors

Constructor and Description
AbstractNettyProtocol(String protocolName)

Method Summary

Methods

Modifier and Type	Method and Description
void	applyProtocol(PlayerSession playerSession, boolean clearExistingProtocolHandlers) This method delegates to the Protocol.applyProtocol(PlayerSession) method after clearing the pipeline based on the input flag.
io.netty.handler.codec.LengthFieldBasedFrameDecoder	createLengthBasedFrameDecoder()
String	getProtocolName() Return the string name of this protocol.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.nadron.protocols.Protocol

applyProtocol

Field Detail

protocolName

final String protocolName

The name of the protocol. This is set by the child class to appropriate value while child class instance is created.

IDLE_STATE_CHECK_HANDLER

public static final String IDLE_STATE_CHECK_HANDLER

Name of the idle state check handlers which will be removed by protocol manually if required from pipeline.

See Also:

Constant Field Values

Constructor Detail

AbstractNettyProtocol

public AbstractNettyProtocol(String protocolName)

Method Detail

createLengthBasedFrameDecoder

public io.netty.handler.codec.LengthFieldBasedFrameDecoder createLengthBasedFrameDecoder()

getProtocolName

public String getProtocolName()

Description copied from interface: Protocol

Return the string name of this protocol.

Specified by:

getProtocolName in interface Protocol

Returns:

name of the protocol. This will be used in scenarios where a custom protocol has been used.

applyProtocol

public void applyProtocol(PlayerSession playerSession,
                 boolean clearExistingProtocolHandlers)

Description copied from interface: Protocol

This method delegates to the Protocol.applyProtocol(PlayerSession) method after clearing the pipeline based on the input flag.

Specified by:

applyProtocol in interface Protocol

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