io.nadron.protocols.impl

Class AMF3StringProtocol

java.lang.Object

io.nadron.protocols.AbstractNettyProtocol

io.nadron.protocols.impl.AMF3StringProtocol

All Implemented Interfaces:

Protocol

public class AMF3StringProtocol
extends AbstractNettyProtocol

This protocol defines AMF3 that is base 64 and String encoded sent over the wire. Used by XMLSocket flash clients to send AMF3 data.

Author:

Abraham Menacherry

Field Summary

Fields

Modifier and Type	Field and Description
private io.netty.handler.codec.base64.Base64Decoder	base64Decoder The flash client would encode the AMF3 bytes into a base 64 encoded string, this decoder is used to decode it back.
private io.netty.handler.codec.base64.Base64Encoder	base64Encoder The flash client expects a AMF3 bytes to be passed in as base 64 encoded string.
private JavaObjectToAMF3Encoder	javaObjectToAMF3Encoder Once the game handler is done with its operations, it writes back the java object to the client.
(package private) int	maxFrameSize 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.

Fields inherited from class io.nadron.protocols.AbstractNettyProtocol

IDLE_STATE_CHECK_HANDLER

Constructor Summary

Constructors

Constructor and Description
AMF3StringProtocol()

Method Summary

Methods

Modifier and Type	Method and Description
void	applyProtocol(PlayerSession playerSession) The main method of this interface.
protected AMF3ToJavaObjectDecoder	createAMF3ToJavaObjectDecoder()
io.netty.handler.codec.base64.Base64Decoder	getBase64Decoder()
io.netty.handler.codec.base64.Base64Encoder	getBase64Encoder()
JavaObjectToAMF3Encoder	getJavaObjectToAMF3Encoder()
int	getMaxFrameSize()
NulEncoder	getNulEncoder()
void	setBase64Decoder(io.netty.handler.codec.base64.Base64Decoder base64Decoder)
void	setBase64Encoder(io.netty.handler.codec.base64.Base64Encoder base64Encoder)
void	setJavaObjectToAMF3Encoder(JavaObjectToAMF3Encoder javaObjectToAMF3Encoder)
void	setMaxFrameSize(int frameSize)
void	setNulEncoder(NulEncoder nulEncoder)

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

maxFrameSize

int maxFrameSize

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

base64Decoder

private io.netty.handler.codec.base64.Base64Decoder base64Decoder

The flash client would encode the AMF3 bytes into a base 64 encoded string, this decoder is used to decode it back.

javaObjectToAMF3Encoder

private JavaObjectToAMF3Encoder javaObjectToAMF3Encoder

Once the game handler is done with its operations, it writes back the java object to the client. When writing back to flash client, it needs to use this encoder to encode it to AMF3 format.

base64Encoder

private io.netty.handler.codec.base64.Base64Encoder base64Encoder

The flash client expects a AMF3 bytes to be passed in as base 64 encoded string. This encoder will encode the bytes accordingly.

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".

Constructor Detail

AMF3StringProtocol

public AMF3StringProtocol()

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.

createAMF3ToJavaObjectDecoder

protected AMF3ToJavaObjectDecoder createAMF3ToJavaObjectDecoder()

getMaxFrameSize

public int getMaxFrameSize()

setMaxFrameSize

public void setMaxFrameSize(int frameSize)

getBase64Decoder

public io.netty.handler.codec.base64.Base64Decoder getBase64Decoder()

setBase64Decoder

public void setBase64Decoder(io.netty.handler.codec.base64.Base64Decoder base64Decoder)

getJavaObjectToAMF3Encoder

public JavaObjectToAMF3Encoder getJavaObjectToAMF3Encoder()

setJavaObjectToAMF3Encoder

public void setJavaObjectToAMF3Encoder(JavaObjectToAMF3Encoder javaObjectToAMF3Encoder)

getBase64Encoder

public io.netty.handler.codec.base64.Base64Encoder getBase64Encoder()

setBase64Encoder

public void setBase64Encoder(io.netty.handler.codec.base64.Base64Encoder base64Encoder)

getNulEncoder

public NulEncoder getNulEncoder()

setNulEncoder

public void setNulEncoder(NulEncoder nulEncoder)