org.thales.punch.netty.impl

Class MonitoringHandler

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.channel.ChannelDuplexHandler

org.thales.punch.netty.impl.MonitoringHandler

All Implemented Interfaces:

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

@ChannelHandler.Sharable
public class MonitoringHandler
extends io.netty.channel.ChannelDuplexHandler

A ChannelHandler that logs all events using a logging framework. By default, all events are logged at DEBUG level.

Nested Class Summary

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

io.netty.channel.ChannelHandler.Sharable

Constructor Summary

Constructors

Constructor and Description
MonitoringHandler(com.codahale.metrics.Counter rawBytesRec, com.codahale.metrics.Counter rawdBytesSent) Creates a new instance to monitor your pipeline

Method Summary

Modifier and Type	Method and Description
void	bind(io.netty.channel.ChannelHandlerContext ctx, SocketAddress localAddress, io.netty.channel.ChannelPromise promise)
void	channelActive(io.netty.channel.ChannelHandlerContext ctx)
void	channelInactive(io.netty.channel.ChannelHandlerContext ctx)
void	channelRead(io.netty.channel.ChannelHandlerContext ctx, Object msg)
void	channelRegistered(io.netty.channel.ChannelHandlerContext ctx)
void	channelUnregistered(io.netty.channel.ChannelHandlerContext ctx)
void	close(io.netty.channel.ChannelHandlerContext ctx, io.netty.channel.ChannelPromise promise)
void	connect(io.netty.channel.ChannelHandlerContext ctx, SocketAddress remoteAddress, SocketAddress localAddress, io.netty.channel.ChannelPromise promise)
void	deregister(io.netty.channel.ChannelHandlerContext ctx, io.netty.channel.ChannelPromise promise)
void	disconnect(io.netty.channel.ChannelHandlerContext ctx, io.netty.channel.ChannelPromise promise)
void	exceptionCaught(io.netty.channel.ChannelHandlerContext ctx, Throwable cause)
void	flush(io.netty.channel.ChannelHandlerContext ctx)
protected static String	format(io.netty.channel.ChannelHandlerContext ctx, String message)
static String	formatByteBuf(String eventName, io.netty.buffer.ByteBuf buf) Returns a String which contains all details to log the ByteBuf
protected static String	formatByteBufHolder(String eventName, io.netty.buffer.ByteBufHolder msg) Returns a String which contains all details to log the ByteBufHolder.
protected static String	formatMessage(String eventName, Object msg)
protected static String	formatNonByteBuf(String eventName, Object msg) Returns a String which contains all details to log the Object
static void	trace(String eventName, byte[] receiveSizeBytes, int n) trace a useful hex dump of some received or written traffic
void	userEventTriggered(io.netty.channel.ChannelHandlerContext ctx, Object evt)
void	write(io.netty.channel.ChannelHandlerContext ctx, Object msg, io.netty.channel.ChannelPromise promise)

Methods inherited from class io.netty.channel.ChannelDuplexHandler

read

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

channelReadComplete, channelWritabilityChanged

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, handlerAdded, handlerRemoved, 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

handlerAdded, handlerRemoved

Constructor Detail

MonitoringHandler

public MonitoringHandler(com.codahale.metrics.Counter rawBytesRec,
                         com.codahale.metrics.Counter rawdBytesSent)

Creates a new instance to monitor your pipeline

Parameters:

rawdBytesSent - a counter to keep track of bytes received

rawBytesRec - a counter to keep track of bytes received

Method Detail

format

protected static String format(io.netty.channel.ChannelHandlerContext ctx,
                               String message)

channelRegistered

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

Specified by:

channelRegistered in interface io.netty.channel.ChannelInboundHandler

Overrides:

channelRegistered in class io.netty.channel.ChannelInboundHandlerAdapter

Throws:

Exception

channelUnregistered

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

Specified by:

channelUnregistered in interface io.netty.channel.ChannelInboundHandler

Overrides:

channelUnregistered in class io.netty.channel.ChannelInboundHandlerAdapter

Throws:

Exception

channelActive

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

Specified by:

channelActive in interface io.netty.channel.ChannelInboundHandler

Overrides:

channelActive in class io.netty.channel.ChannelInboundHandlerAdapter

Throws:

Exception

channelInactive

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

Specified by:

channelInactive in interface io.netty.channel.ChannelInboundHandler

Overrides:

channelInactive in class io.netty.channel.ChannelInboundHandlerAdapter

Throws:

Exception

exceptionCaught

public void exceptionCaught(io.netty.channel.ChannelHandlerContext ctx,
                            Throwable cause)
                     throws Exception

Specified by:

exceptionCaught in interface io.netty.channel.ChannelHandler

Specified by:

exceptionCaught in interface io.netty.channel.ChannelInboundHandler

Overrides:

exceptionCaught in class io.netty.channel.ChannelInboundHandlerAdapter

Throws:

Exception

userEventTriggered

public void userEventTriggered(io.netty.channel.ChannelHandlerContext ctx,
                               Object evt)
                        throws Exception

Specified by:

userEventTriggered in interface io.netty.channel.ChannelInboundHandler

Overrides:

userEventTriggered in class io.netty.channel.ChannelInboundHandlerAdapter

Throws:

Exception

bind

public void bind(io.netty.channel.ChannelHandlerContext ctx,
                 SocketAddress localAddress,
                 io.netty.channel.ChannelPromise promise)
          throws Exception

Specified by:

bind in interface io.netty.channel.ChannelOutboundHandler

Overrides:

bind in class io.netty.channel.ChannelDuplexHandler

Throws:

Exception

connect

public void connect(io.netty.channel.ChannelHandlerContext ctx,
                    SocketAddress remoteAddress,
                    SocketAddress localAddress,
                    io.netty.channel.ChannelPromise promise)
             throws Exception

Specified by:

connect in interface io.netty.channel.ChannelOutboundHandler

Overrides:

connect in class io.netty.channel.ChannelDuplexHandler

Throws:

Exception

disconnect

public void disconnect(io.netty.channel.ChannelHandlerContext ctx,
                       io.netty.channel.ChannelPromise promise)
                throws Exception

Specified by:

disconnect in interface io.netty.channel.ChannelOutboundHandler

Overrides:

disconnect in class io.netty.channel.ChannelDuplexHandler

Throws:

Exception

close

public void close(io.netty.channel.ChannelHandlerContext ctx,
                  io.netty.channel.ChannelPromise promise)
           throws Exception

Specified by:

close in interface io.netty.channel.ChannelOutboundHandler

Overrides:

close in class io.netty.channel.ChannelDuplexHandler

Throws:

Exception

deregister

public void deregister(io.netty.channel.ChannelHandlerContext ctx,
                       io.netty.channel.ChannelPromise promise)
                throws Exception

Specified by:

deregister in interface io.netty.channel.ChannelOutboundHandler

Overrides:

deregister in class io.netty.channel.ChannelDuplexHandler

Throws:

Exception

channelRead

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

Specified by:

channelRead in interface io.netty.channel.ChannelInboundHandler

Overrides:

channelRead in class io.netty.channel.ChannelInboundHandlerAdapter

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.channel.ChannelDuplexHandler

Throws:

Exception

flush

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

Specified by:

flush in interface io.netty.channel.ChannelOutboundHandler

Overrides:

flush in class io.netty.channel.ChannelDuplexHandler

Throws:

Exception

formatMessage

protected static String formatMessage(String eventName,
                                      Object msg)

formatByteBuf

public static String formatByteBuf(String eventName,
                                   io.netty.buffer.ByteBuf buf)

Returns a String which contains all details to log the ByteBuf

Parameters:

eventName - the event name

buf - the data buffer

Returns:

the resulting String

formatNonByteBuf

protected static String formatNonByteBuf(String eventName,
                                         Object msg)

Returns a String which contains all details to log the Object

formatByteBufHolder

protected static String formatByteBufHolder(String eventName,
                                            io.netty.buffer.ByteBufHolder msg)

Returns a String which contains all details to log the ByteBufHolder.

By default this method just delegates to formatByteBuf(String, ByteBuf), using the content of the ByteBufHolder. Sub-classes may override this.

trace

public static void trace(String eventName,
                         byte[] receiveSizeBytes,
                         int n)

trace a useful hex dump of some received or written traffic

Parameters:

eventName -

receiveSizeBytes -

n -