com.ibasco.agql.protocols.valve.source.query.common.handlers

Class SourceQueryDecoder<T extends SourceQueryRequest>

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

com.ibasco.agql.core.transport.handlers.MessageInboundHandler

com.ibasco.agql.protocols.valve.source.query.common.handlers.SourceQueryDecoder<T>

Type Parameters:

T - The type of SourceQueryRequest this decoder will handle/process

All Implemented Interfaces:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler

Direct Known Subclasses:

SourceQueryAuthDecoder, SourceQueryChallengeDecoder

public abstract class SourceQueryDecoder<T extends SourceQueryRequest>
extends MessageInboundHandler

A special decoder used for messages based on the Source Query Protocol. This handler Accepts either an instance of SourceQueryPacket or a SourceQueryResponse

Author:

Rafael Luis Ibasco

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	SourceQueryDecoder.SourceQueryMessage

Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

io.netty.channel.ChannelHandler.Sharable

Constructor Summary

Constructors

Constructor and Description
SourceQueryDecoder()

Method Summary

Modifier and Type	Method and Description
protected abstract boolean	acceptPacket(SourceQueryDecoder.SourceQueryMessage msg) acceptPacket.
protected <A,B> void	decodeField(String name, io.netty.buffer.ByteBuf buf, Function<io.netty.buffer.ByteBuf,A> reader, Consumer<B> writer) Decode as a field from the given ByteBuf.
protected <A,B> void	decodeField(String name, io.netty.buffer.ByteBuf buf, Function<io.netty.buffer.ByteBuf,A> reader, Consumer<B> writer, Function<A,B> transformer) Decode as a field from the given ByteBuf.
protected <A,B> void	decodeField(String name, io.netty.buffer.ByteBuf buf, Supplier<A> reader, Consumer<B> writer) Decode as a field from the given ByteBuf.
protected <A,B> void	decodeField(String name, io.netty.buffer.ByteBuf buf, Supplier<A> reader, Consumer<B> writer, Function<A,B> transformer) Decode as a field from the given ByteBuf.
protected <V> V	decodeField(String name, V defaultValue, io.netty.buffer.ByteBuf buf, Function<io.netty.buffer.ByteBuf,V> decoder) Decode as a field from the given ByteBuf.
protected <A,B> void	decodeFlag(String name, io.netty.buffer.ByteBuf buf, int flags, int flag, Function<io.netty.buffer.ByteBuf,A> reader, Consumer<B> writer) Decodes a flag from the provided int value.
protected <A,B> void	decodeFlag(String name, io.netty.buffer.ByteBuf buf, int flags, int flag, Function<io.netty.buffer.ByteBuf,A> reader, Consumer<B> writer, Function<A,B> transformer) Decodes a flag from the provided int value.
protected <A,B> void	decodeFlag(String name, io.netty.buffer.ByteBuf buf, int flags, int flag, Supplier<A> reader, Consumer<B> writer) Decodes a flag from the provided int value.
protected <A,B> void	decodeFlag(String name, io.netty.buffer.ByteBuf buf, int flags, int flag, Supplier<A> reader, Consumer<B> writer, Function<A,B> transformer) Decodes a flag from the provided int value.
protected abstract Object	decodePacket(io.netty.channel.ChannelHandlerContext ctx, T request, SourceQuerySinglePacket msg) decodePacket.
void	readMessage(io.netty.channel.ChannelHandlerContext ctx, Object msg) readMessage.

Methods inherited from class com.ibasco.agql.core.transport.handlers.MessageInboundHandler

channelRead, debug, debug, debug, debug, error, error, handlerAdded, handlerRemoved, info, isDebugEnabled, log, log, printField, trace, warn

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

channelActive, channelInactive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught, userEventTriggered

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, isSharable

Methods inherited from class java.lang.Object

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

Constructor Detail

SourceQueryDecoder

public SourceQueryDecoder()

Method Detail

readMessage

public final void readMessage(io.netty.channel.ChannelHandlerContext ctx,
                              Object msg)
                       throws Exception

readMessage.

Overrides:

readMessage in class MessageInboundHandler

Parameters:

ctx - a ChannelHandlerContext object

msg - a Object object

Throws:

Exception - if any.

acceptPacket

protected abstract boolean acceptPacket(SourceQueryDecoder.SourceQueryMessage msg)

acceptPacket.

Parameters:

msg - a SourceQueryDecoder.SourceQueryMessage object

Returns:

a boolean

decodePacket

protected abstract Object decodePacket(io.netty.channel.ChannelHandlerContext ctx,
                                       T request,
                                       SourceQuerySinglePacket msg)
                                throws Exception

decodePacket.

Parameters:

ctx - a ChannelHandlerContext object

request - a T object

msg - a SourceQuerySinglePacket object

Returns:

a Object object

Throws:

Exception - if any.

decodeFlag

protected <A,B> void decodeFlag(String name,
                                io.netty.buffer.ByteBuf buf,
                                int flags,
                                int flag,
                                Supplier<A> reader,
                                Consumer<B> writer)
                         throws DecodeException

Decodes a flag from the provided int value.

Type Parameters:

A - a A class

B - a B class

Parameters:

name - a String object

buf - a ByteBuf object

flags - a int

flag - a int

reader - a Supplier object

writer - a Consumer object

Throws:

DecodeException - if any.

decodeFlag

protected <A,B> void decodeFlag(String name,
                                io.netty.buffer.ByteBuf buf,
                                int flags,
                                int flag,
                                Supplier<A> reader,
                                Consumer<B> writer,
                                Function<A,B> transformer)
                         throws DecodeException

Decodes a flag from the provided int value.

Type Parameters:

A - a A class

B - a B class

Parameters:

name - a String object

buf - a ByteBuf object

flags - a int

flag - a int

reader - a Supplier object

writer - a Consumer object

transformer - a Function object

Throws:

DecodeException - if any.

decodeFlag

protected <A,B> void decodeFlag(String name,
                                io.netty.buffer.ByteBuf buf,
                                int flags,
                                int flag,
                                Function<io.netty.buffer.ByteBuf,A> reader,
                                Consumer<B> writer,
                                Function<A,B> transformer)
                         throws DecodeException

Decodes a flag from the provided int value.

Type Parameters:

A - a A class

B - a B class

Parameters:

name - a String object

buf - a ByteBuf object

flags - a int

flag - a int

reader - a Function object

writer - a Consumer object

transformer - a Function object

Throws:

DecodeException - if any.

decodeFlag

protected <A,B> void decodeFlag(String name,
                                io.netty.buffer.ByteBuf buf,
                                int flags,
                                int flag,
                                Function<io.netty.buffer.ByteBuf,A> reader,
                                Consumer<B> writer)
                         throws DecodeException

Decodes a flag from the provided int value.

Type Parameters:

A - a A class

B - a B class

Parameters:

name - a String object

buf - a ByteBuf object

flags - a int

flag - a int

reader - a Function object

writer - a Consumer object

Throws:

DecodeException - if any.

decodeField

protected <A,B> void decodeField(String name,
                                 io.netty.buffer.ByteBuf buf,
                                 Supplier<A> reader,
                                 Consumer<B> writer)
                          throws DecodeException

Decode as a field from the given ByteBuf.

Type Parameters:

A - a A class

B - a B class

Parameters:

name - a String object

buf - a ByteBuf object

reader - a Supplier object

writer - a Consumer object

Throws:

DecodeException - if any.

decodeField

protected <A,B> void decodeField(String name,
                                 io.netty.buffer.ByteBuf buf,
                                 Supplier<A> reader,
                                 Consumer<B> writer,
                                 Function<A,B> transformer)
                          throws DecodeException

Decode as a field from the given ByteBuf.

Type Parameters:

A - a A class

B - a B class

Parameters:

name - a String object

buf - a ByteBuf object

reader - a Supplier object

writer - a Consumer object

transformer - a Function object

Throws:

DecodeException - if any.

decodeField

protected <A,B> void decodeField(String name,
                                 io.netty.buffer.ByteBuf buf,
                                 Function<io.netty.buffer.ByteBuf,A> reader,
                                 Consumer<B> writer,
                                 Function<A,B> transformer)
                          throws DecodeException

Decode as a field from the given ByteBuf.

Type Parameters:

A - a A class

B - a B class

Parameters:

name - a String object

buf - a ByteBuf object

reader - a Function object

writer - a Consumer object

transformer - a Function object

Throws:

DecodeException - if any.

decodeField

protected <A,B> void decodeField(String name,
                                 io.netty.buffer.ByteBuf buf,
                                 Function<io.netty.buffer.ByteBuf,A> reader,
                                 Consumer<B> writer)
                          throws DecodeException

Decode as a field from the given ByteBuf.

Type Parameters:

A - a A class

B - a B class

Parameters:

name - a String object

buf - a ByteBuf object

reader - a Function object

writer - a Consumer object

Throws:

DecodeException - if any.

decodeField

protected <V> V decodeField(String name,
                            V defaultValue,
                            io.netty.buffer.ByteBuf buf,
                            Function<io.netty.buffer.ByteBuf,V> decoder)
                     throws DecodeException

Decode as a field from the given ByteBuf.

Type Parameters:

V - a V class

Parameters:

name - a String object

defaultValue - a V object

buf - a ByteBuf object

decoder - a Function object

Returns:

a V object

Throws:

DecodeException - if any.