io.nadron.util

Class NettyUtils

java.lang.Object

io.nadron.util.NettyUtils

public class NettyUtils
extends Object

This class would be an assortment of netty related utility methods.

Author:

Abraham Menacherry

Field Summary

Fields

Modifier and Type	Field and Description
private static org.slf4j.Logger	LOG
static String	NETTY_CHANNEL

Constructor Summary

Constructors

Constructor and Description
NettyUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static void	clearPipeline(io.netty.channel.ChannelPipeline pipeline) A utility method to clear the netty pipeline of all handlers.
static io.netty.buffer.ByteBuf	createBufferForOpcode(int opcode)
static io.netty.channel.ChannelPipeline	getPipeLineOfConnection(NettyTCPMessageSender messageSender)
static io.netty.channel.ChannelPipeline	getPipeLineOfConnection(PlayerSession playerSession)
static <T,V> V	readObject(io.netty.buffer.ByteBuf buffer, Transform<io.netty.buffer.ByteBuf,V> decoder)
static InetSocketAddress	readSocketAddress(io.netty.buffer.ByteBuf buffer) Read a socket address from a buffer.
static String	readString(io.netty.buffer.ByteBuf buffer) This method will first read an unsigned short to find the length of the string and then read the actual string based on the length.
static String	readString(io.netty.buffer.ByteBuf buffer, Charset charset) This method will first read an unsigned short to find the length of the string and then read the actual string based on the length.
static String	readString(io.netty.buffer.ByteBuf buffer, int length) Read a string from a channel buffer with the specified length.
static String	readString(io.netty.buffer.ByteBuf buffer, int length, Charset charset) Read a string from a channel buffer with the specified length.
static String[]	readStrings(io.netty.buffer.ByteBuf buffer, int numOfStrings) This method will read multiple strings of the buffer and return them as a string array.
static String[]	readStrings(io.netty.buffer.ByteBuf buffer, int numOfStrings, Charset charset) This method will read multiple strings of the buffer and return them as a string array.
static <V> io.netty.buffer.ByteBuf	writeObject(Transform<V,io.netty.buffer.ByteBuf> converter, V object)
static io.netty.buffer.ByteBuf	writeSocketAddress(InetSocketAddress socketAddress)
static io.netty.buffer.ByteBuf	writeString(String msg) Creates a channel buffer of which the first 2 bytes contain the length of the string in bytes and the remaining is the actual string in binary UTF-8 format.
static io.netty.buffer.ByteBuf	writeString(String msg, Charset charset) Creates a channel buffer of which the first 2 bytes contain the length of the string in bytes and the remaining is the actual string in binary with specified format.
static io.netty.buffer.ByteBuf	writeStrings(Charset charset, String... msgs) Writes multiple strings to a ByteBuf with the length of the string preceding its content.
static io.netty.buffer.ByteBuf	writeStrings(String... msgs) Writes multiple strings to a ByteBuf with the length of the string preceding its content.

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

NETTY_CHANNEL

public static final String NETTY_CHANNEL

See Also:

Constant Field Values

Constructor Detail

NettyUtils

public NettyUtils()

Method Detail

getPipeLineOfConnection

public static io.netty.channel.ChannelPipeline getPipeLineOfConnection(NettyTCPMessageSender messageSender)

getPipeLineOfConnection

public static io.netty.channel.ChannelPipeline getPipeLineOfConnection(PlayerSession playerSession)

clearPipeline

public static void clearPipeline(io.netty.channel.ChannelPipeline pipeline)

A utility method to clear the netty pipeline of all handlers.

Parameters:

pipeline -

createBufferForOpcode

public static io.netty.buffer.ByteBuf createBufferForOpcode(int opcode)

readStrings

public static String[] readStrings(io.netty.buffer.ByteBuf buffer,
                   int numOfStrings)

This method will read multiple strings of the buffer and return them as a string array. It internally uses the readString(ByteBuf buffer) to accomplish this task. The strings are read back in the order they are written.

Parameters:

buffer - The buffer containing the strings, with each string being a strlength-strbytes combination.

numOfStrings - The number of strings to be read. Should not be negative or 0

Returns:

the strings read from the buffer as an array.

readStrings

public static String[] readStrings(io.netty.buffer.ByteBuf buffer,
                   int numOfStrings,
                   Charset charset)

This method will read multiple strings of the buffer and return them as a string array. It internally uses the readString(ByteBuf buffer) to accomplish this task. The strings are read back in the order they are written.

Parameters:

buffer - The buffer containing the strings, with each string being a strlength-strbytes combination.

numOfStrings - The number of strings to be read. Should not be negative or 0

charset - The Charset say 'UTF-8' in which the decoding needs to be done.

Returns:

the strings read from the buffer as an array.

readString

public static String readString(io.netty.buffer.ByteBuf buffer)

This method will first read an unsigned short to find the length of the string and then read the actual string based on the length. This method will also reset the reader index to end of the string

Parameters:

buffer - The Netty buffer containing at least one unsigned short followed by a string of similar length.

Returns:

Returns the String or throws IndexOutOfBoundsException if the length is greater than expected.

readString

public static String readString(io.netty.buffer.ByteBuf buffer,
                Charset charset)

This method will first read an unsigned short to find the length of the string and then read the actual string based on the length. This method will also reset the reader index to end of the string

Parameters:

buffer - The Netty buffer containing at least one unsigned short followed by a string of similar length.

charset - The Charset say 'UTF-8' in which the decoding needs to be done.

Returns:

Returns the String or throws IndexOutOfBoundsException if the length is greater than expected.

readString

public static String readString(io.netty.buffer.ByteBuf buffer,
                int length)

Read a string from a channel buffer with the specified length. It resets the reader index of the buffer to the end of the string.

Parameters:

buffer - The Netty buffer containing the String.

length - The number of bytes in the String.

Returns:

Returns the read string.

readString

public static String readString(io.netty.buffer.ByteBuf buffer,
                int length,
                Charset charset)

Read a string from a channel buffer with the specified length. It resets the reader index of the buffer to the end of the string. Defaults to UTF-8 encoding in case charset passed in is null

Parameters:

buffer - The Netty buffer containing the String.

length - The number of bytes in the String.

charset - The Charset say 'UTF-8' in which the decoding needs to be done.

Returns:

Returns the read string.

writeStrings

public static io.netty.buffer.ByteBuf writeStrings(String... msgs)

Writes multiple strings to a ByteBuf with the length of the string preceding its content. So if there are two string Hello and World then the channel buffer returned would contain

Parameters:

msgs - The messages to be written.

Returns:

ByteBuf with format length-stringbinary-length-stringbinary

writeStrings

public static io.netty.buffer.ByteBuf writeStrings(Charset charset,
                                   String... msgs)

Writes multiple strings to a ByteBuf with the length of the string preceding its content. So if there are two string Hello and World then the channel buffer returned would contain

Parameters:

charset - The Charset say 'UTF-8' in which the encoding needs to be done.

msgs - The messages to be written.

Returns:

ByteBuf with format length-stringbinary-length-stringbinary

writeString

public static io.netty.buffer.ByteBuf writeString(String msg)

Creates a channel buffer of which the first 2 bytes contain the length of the string in bytes and the remaining is the actual string in binary UTF-8 format.

Parameters:

msg - The string to be written.

Returns:

Returns the ByteBuf instance containing the encoded string

writeString

public static io.netty.buffer.ByteBuf writeString(String msg,
                                  Charset charset)

Creates a channel buffer of which the first 2 bytes contain the length of the string in bytes and the remaining is the actual string in binary with specified format. Defaults to UTF-8 encoding in case charset passed in is null

Parameters:

msg - The string to be written.

charset - The Charset say 'UTF-8' in which the encoding needs to be done.

Returns:

The Netty channel buffer containing the string encoded as bytes in the provided charset. It will return null if the string parameter is null.

readObject

public static <T,V> V readObject(io.netty.buffer.ByteBuf buffer,
                 Transform<io.netty.buffer.ByteBuf,V> decoder)

writeObject

public static <V> io.netty.buffer.ByteBuf writeObject(Transform<V,io.netty.buffer.ByteBuf> converter,
                                      V object)

readSocketAddress

public static InetSocketAddress readSocketAddress(io.netty.buffer.ByteBuf buffer)

Read a socket address from a buffer. The socket address will be provided as two strings containing host and port.

Parameters:

buffer - The buffer containing the host and port as string.

Returns:

The InetSocketAddress object created from host and port or null in case the strings are not there.

writeSocketAddress

public static io.netty.buffer.ByteBuf writeSocketAddress(InetSocketAddress socketAddress)