com.ibasco.agql.core.transport.handlers

Class MessageOutboundEncoder<T extends AbstractRequest>

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelOutboundHandlerAdapter

io.netty.handler.codec.MessageToMessageEncoder<Envelope<T>>

com.ibasco.agql.core.transport.handlers.MessageOutboundEncoder<T>

All Implemented Interfaces:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelOutboundHandler

Direct Known Subclasses:

MasterServerRequestEncoder, SourceQueryEncoder, SourceRconAuthEncoder, SourceRconCmdEncoder

public abstract class MessageOutboundEncoder<T extends AbstractRequest>
extends io.netty.handler.codec.MessageToMessageEncoder<Envelope<T>>

Abstract MessageOutboundEncoder class.

Author:

Rafael Luis Ibasco

Nested Class Summary

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

io.netty.channel.ChannelHandler.Sharable

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MessageOutboundEncoder() Constructor for MessageOutboundEncoder.
protected	MessageOutboundEncoder(Class<Envelope<T>> outboundMessageType) Constructor for MessageOutboundEncoder.

Method Summary

Modifier and Type	Method and Description
protected boolean	acceptMessage(Class<T> requestClass, Envelope<T> envelope) acceptMessage.
boolean	acceptOutboundMessage(Object msg)
protected void	debug(String msg, Object... args) debug.
protected void	encode(io.netty.channel.ChannelHandlerContext ctx, Envelope<T> msg, List<Object> out)
protected abstract void	encodeMessage(io.netty.channel.ChannelHandlerContext ctx, Envelope<T> msg, List<Object> out) encodeMessage.
protected void	error(String msg, Object... args) error.
protected NettyChannelContext	getContext() getContext.
protected Envelope<AbstractRequest>	getRequest() getRequest.
void	handlerAdded(io.netty.channel.ChannelHandlerContext ctx)
void	handlerRemoved(io.netty.channel.ChannelHandlerContext ctx)
protected void	info(String msg, Object... args) info.
protected boolean	isDebugEnabled() isDebugEnabled.
protected void	log(String msg, BiConsumer<String,Object[]> level, Object... args) log.
protected void	trace(String msg, Object... args) trace.
protected void	warn(String msg, Object... args) warn.
void	write(io.netty.channel.ChannelHandlerContext ctx, Object msg, io.netty.channel.ChannelPromise promise)

Methods inherited from class io.netty.channel.ChannelOutboundHandlerAdapter

bind, close, connect, deregister, disconnect, flush, read

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, exceptionCaught, isSharable

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.netty.channel.ChannelHandler

exceptionCaught

Constructor Detail

MessageOutboundEncoder

protected MessageOutboundEncoder()

Constructor for MessageOutboundEncoder.

MessageOutboundEncoder

protected MessageOutboundEncoder(Class<Envelope<T>> outboundMessageType)

Constructor for MessageOutboundEncoder.

Parameters:

outboundMessageType - a Class object

Method Detail

acceptOutboundMessage

public final boolean acceptOutboundMessage(Object msg)
                                    throws Exception

Overrides:

acceptOutboundMessage in class io.netty.handler.codec.MessageToMessageEncoder<Envelope<T extends AbstractRequest>>

Throws:

Exception

write

public void write(io.netty.channel.ChannelHandlerContext ctx,
                  Object msg,
                  io.netty.channel.ChannelPromise promise)
           throws Exception

Specified by:

write in interface io.netty.channel.ChannelOutboundHandler

Overrides:

write in class io.netty.handler.codec.MessageToMessageEncoder<Envelope<T extends AbstractRequest>>

Throws:

Exception

encode

protected final void encode(io.netty.channel.ChannelHandlerContext ctx,
                            Envelope<T> msg,
                            List<Object> out)
                     throws Exception

Specified by:

encode in class io.netty.handler.codec.MessageToMessageEncoder<Envelope<T extends AbstractRequest>>

Throws:

Exception

encodeMessage

protected abstract void encodeMessage(io.netty.channel.ChannelHandlerContext ctx,
                                      Envelope<T> msg,
                                      List<Object> out)
                               throws Exception

encodeMessage.

Parameters:

ctx - a ChannelHandlerContext object

msg - a Envelope object

out - a List object

Throws:

Exception - if any.

debug

protected final void debug(String msg,
                           Object... args)

debug.

Parameters:

msg - a String object

args - a Object object

acceptMessage

protected boolean acceptMessage(Class<T> requestClass,
                                Envelope<T> envelope)
                         throws Exception

acceptMessage.

Parameters:

requestClass - a Class object

envelope - a Envelope object

Returns:

a boolean

Throws:

Exception - if any.

log

protected final void log(String msg,
                         BiConsumer<String,Object[]> level,
                         Object... args)

log.

Parameters:

msg - a String object

level - a BiConsumer object

args - a Object object

handlerAdded

public void handlerAdded(io.netty.channel.ChannelHandlerContext ctx)
                  throws Exception

Specified by:

handlerAdded in interface io.netty.channel.ChannelHandler

Overrides:

handlerAdded in class io.netty.channel.ChannelHandlerAdapter

Throws:

Exception

handlerRemoved

public void handlerRemoved(io.netty.channel.ChannelHandlerContext ctx)
                    throws Exception

Specified by:

handlerRemoved in interface io.netty.channel.ChannelHandler

Overrides:

handlerRemoved in class io.netty.channel.ChannelHandlerAdapter

Throws:

Exception

getRequest

protected final Envelope<AbstractRequest> getRequest()

getRequest.

Returns:

a Envelope object

getContext

protected final NettyChannelContext getContext()

getContext.

Returns:

a NettyChannelContext object

isDebugEnabled

protected final boolean isDebugEnabled()

isDebugEnabled.

Returns:

a boolean

trace

protected final void trace(String msg,
                           Object... args)

trace.

Parameters:

msg - a String object

args - a Object object

error

protected final void error(String msg,
                           Object... args)

error.

Parameters:

msg - a String object

args - a Object object

info

protected final void info(String msg,
                          Object... args)

info.

Parameters:

msg - a String object

args - a Object object

warn

protected final void warn(String msg,
                          Object... args)

warn.

Parameters:

msg - a String object

args - a Object object