io.nadron.protocols.impl

Class ChannelBufferProtocol

java.lang.Object

io.nadron.protocols.AbstractNettyProtocol

io.nadron.protocols.impl.ChannelBufferProtocol

All Implemented Interfaces:

Protocol

public class ChannelBufferProtocol
extends AbstractNettyProtocol

A simple protocol which would just strip out the length bytes from the buffer and return the Netty ChannelBuffer to the next decoder or game handler in the ChannelPipeline. For out going messages it will set the length using the LengthFieldPrepender encoder. The binary packets it receives will be of the format [OPCODE][LENGTH][PAYLOAD] will find this protocol the most useful.

Author:

Abraham Menacherry

Field Summary

Fields

Modifier and Type	Field and Description
private EventDecoder	eventDecoder
private EventEncoder	eventEncoder
private io.netty.handler.codec.LengthFieldPrepender	lengthFieldPrepender Utility handler provided by netty to add the length of the outgoing message to the message as a header.
private static org.slf4j.Logger	LOG

Fields inherited from class io.nadron.protocols.AbstractNettyProtocol

IDLE_STATE_CHECK_HANDLER

Constructor Summary

Constructors

Constructor and Description
ChannelBufferProtocol()

Method Summary

Methods

Modifier and Type	Method and Description
void	applyProtocol(PlayerSession playerSession) The main method of this interface.
EventDecoder	getEventDecoder()
EventEncoder	getEventEncoder()
io.netty.handler.codec.LengthFieldPrepender	getLengthFieldPrepender()
void	setEventDecoder(EventDecoder eventDecoder)
void	setEventEncoder(EventEncoder eventEncoder)
void	setLengthFieldPrepender(io.netty.handler.codec.LengthFieldPrepender lengthFieldPrepender)

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

LOG

private static final org.slf4j.Logger LOG

lengthFieldPrepender

private io.netty.handler.codec.LengthFieldPrepender lengthFieldPrepender

Utility handler provided by netty to add the length of the outgoing message to the message as a header.

eventDecoder

private EventDecoder eventDecoder

eventEncoder

private EventEncoder eventEncoder

Constructor Detail

ChannelBufferProtocol

public ChannelBufferProtocol()

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.

getLengthFieldPrepender

public io.netty.handler.codec.LengthFieldPrepender getLengthFieldPrepender()

setLengthFieldPrepender

public void setLengthFieldPrepender(io.netty.handler.codec.LengthFieldPrepender lengthFieldPrepender)

getEventDecoder

public EventDecoder getEventDecoder()

setEventDecoder

public void setEventDecoder(EventDecoder eventDecoder)

getEventEncoder

public EventEncoder getEventEncoder()

setEventEncoder

public void setEventEncoder(EventEncoder eventEncoder)