io.nadron.protocols.impl

Class StringProtocol

java.lang.Object

io.nadron.protocols.AbstractNettyProtocol

io.nadron.protocols.impl.StringProtocol

All Implemented Interfaces:

Protocol

public class StringProtocol
extends AbstractNettyProtocol

Field Summary

Fields

Modifier and Type	Field and Description
(package private) int	frameSize The maximum size of the incoming message in bytes.
private NulEncoder	nulEncoder Flash client expects a nul byte 0x00 to be added as the end byte of any communication with it.
private io.netty.handler.codec.string.StringDecoder	stringDecoder Used to decode a netty ByteBuf (actually a byte array) to a string.
private io.netty.handler.codec.string.StringEncoder	stringEncoder Used to encode a normal java String to a netty ByteBuf (actually a byte array).

Fields inherited from class io.nadron.protocols.AbstractNettyProtocol

IDLE_STATE_CHECK_HANDLER

Constructor Summary

Constructors

Constructor and Description
StringProtocol()
StringProtocol(int frameSize, NulEncoder nulEncoder, io.netty.handler.codec.string.StringDecoder stringDecoder, io.netty.handler.codec.string.StringEncoder stringEncoder)

Method Summary

Methods

Modifier and Type	Method and Description
void	applyProtocol(PlayerSession playerSession) The main method of this interface.
int	getFrameSize()
NulEncoder	getNulEncoder()
io.netty.handler.codec.string.StringDecoder	getStringDecoder()
io.netty.handler.codec.string.StringEncoder	getStringEncoder()
void	setFrameSize(int frameSize)
void	setNulEncoder(NulEncoder nulEncoder)
void	setStringDecoder(io.netty.handler.codec.string.StringDecoder stringDecoder)
void	setStringEncoder(io.netty.handler.codec.string.StringEncoder stringEncoder)

Methods inherited from class io.nadron.protocols.AbstractNettyProtocol

applyProtocol, createLengthBasedFrameDecoder, getProtocolName

Methods inherited from class java.lang.Object

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

Field Detail

frameSize

int frameSize

The maximum size of the incoming message in bytes. The DelimiterBasedFrameDecoder will use this value in order to throw a TooLongFrameException.

nulEncoder

private NulEncoder nulEncoder

Flash client expects a nul byte 0x00 to be added as the end byte of any communication with it. This encoder will add this nul byte to the end of the message. Could be considered as a message "footer".

stringDecoder

private io.netty.handler.codec.string.StringDecoder stringDecoder

Used to decode a netty ByteBuf (actually a byte array) to a string.

stringEncoder

private io.netty.handler.codec.string.StringEncoder stringEncoder

Used to encode a normal java String to a netty ByteBuf (actually a byte array).

Constructor Detail

StringProtocol

public StringProtocol()

StringProtocol

public StringProtocol(int frameSize,
              NulEncoder nulEncoder,
              io.netty.handler.codec.string.StringDecoder stringDecoder,
              io.netty.handler.codec.string.StringEncoder stringEncoder)

Method Detail

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.

getFrameSize

public int getFrameSize()

setFrameSize

public void setFrameSize(int frameSize)

getNulEncoder

public NulEncoder getNulEncoder()

setNulEncoder

public void setNulEncoder(NulEncoder nulEncoder)

getStringDecoder

public io.netty.handler.codec.string.StringDecoder getStringDecoder()

setStringDecoder

public void setStringDecoder(io.netty.handler.codec.string.StringDecoder stringDecoder)

getStringEncoder

public io.netty.handler.codec.string.StringEncoder getStringEncoder()

setStringEncoder

public void setStringEncoder(io.netty.handler.codec.string.StringEncoder stringEncoder)