All Implemented Interfaces:

ChannelHandler, ChannelInboundHandler, ChannelOutboundHandler

@ChannelHandler.Sharable
public class LoggingHandler
extends ChannelDuplexHandler 

• Nested Class Summary

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

    ChannelHandler.Sharable

• Field Summary

  Fields

  Modifier and Type	Field and Description
  protected io.netty.util.internal.logging.InternalLogLevel	internalLevel
  protected io.netty.util.internal.logging.InternalLogger	logger

• Constructor Summary

  Constructors

  Constructor and Description
  LoggingHandler () Creates a new instance whose logger name is the fully qualified class name of the instance with hex dump enabled.
  LoggingHandler (java.lang.Class<?> clazz) Creates a new instance with the specified logger name and with hex dump enabled.
  LoggingHandler (java.lang.Class<?> clazz, LogLevel level) Creates a new instance with the specified logger name.
  LoggingHandler (LogLevel level) Creates a new instance whose logger name is the fully qualified class name of the instance.
  LoggingHandler (java.lang.String name) Creates a new instance with the specified logger name.
  LoggingHandler (java.lang.String name, LogLevel level) Creates a new instance with the specified logger name.

• Method Summary

  All Methods

  Modifier and Type	Method and Description
  void	bind (ChannelHandlerContext ctx, java.net.SocketAddress localAddress, ChannelPromise promise) Calls ChannelHandlerContext.bind(SocketAddress, ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.
  void	channelActive (ChannelHandlerContext ctx) Calls ChannelHandlerContext.fireChannelActive() to forward to the next ChannelInboundHandler in the ChannelPipeline.
  void	channelInactive (ChannelHandlerContext ctx) Calls ChannelHandlerContext.fireChannelInactive() to forward to the next ChannelInboundHandler in the ChannelPipeline.
  void	channelRead (ChannelHandlerContext ctx, java.lang.Object msg) Calls ChannelHandlerContext.fireChannelRead(Object) to forward to the next ChannelInboundHandler in the ChannelPipeline.
  void	channelReadComplete (ChannelHandlerContext ctx) Calls ChannelHandlerContext.fireChannelReadComplete() to forward to the next ChannelInboundHandler in the ChannelPipeline.
  void	channelRegistered (ChannelHandlerContext ctx) Calls ChannelHandlerContext.fireChannelRegistered() to forward to the next ChannelInboundHandler in the ChannelPipeline.
  void	channelUnregistered (ChannelHandlerContext ctx) Calls ChannelHandlerContext.fireChannelUnregistered() to forward to the next ChannelInboundHandler in the ChannelPipeline.
  void	channelWritabilityChanged (ChannelHandlerContext ctx) Calls ChannelHandlerContext.fireChannelWritabilityChanged() to forward to the next ChannelInboundHandler in the ChannelPipeline.
  void	close (ChannelHandlerContext ctx, ChannelPromise promise) Calls ChannelHandlerContext.close(ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.
  void	connect (ChannelHandlerContext ctx, java.net.SocketAddress remoteAddress, java.net.SocketAddress localAddress, ChannelPromise promise) Calls ChannelHandlerContext.connect(SocketAddress, SocketAddress, ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.
  void	deregister (ChannelHandlerContext ctx, ChannelPromise promise) Calls ChannelHandlerContext.close(ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.
  void	disconnect (ChannelHandlerContext ctx, ChannelPromise promise) Calls ChannelHandlerContext.disconnect(ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.
  void	exceptionCaught (ChannelHandlerContext ctx, java.lang.Throwable cause) Calls ChannelHandlerContext.fireExceptionCaught(Throwable) to forward to the next ChannelHandler in the ChannelPipeline.
  void	flush (ChannelHandlerContext ctx) Calls ChannelHandlerContext.flush() to forward to the next ChannelOutboundHandler in the ChannelPipeline.
  protected java.lang.String	format (ChannelHandlerContext ctx, java.lang.String message)
  protected java.lang.String	formatByteBuf (java.lang.String eventName, ByteBuf msg) Returns a String which contains all details to log the ByteBuf
  protected java.lang.String	formatByteBufHolder (java.lang.String eventName, ByteBufHolder msg) Returns a String which contains all details to log the ByteBufHolder.
  protected java.lang.String	formatMessage (java.lang.String eventName, java.lang.Object msg)
  protected java.lang.String	formatNonByteBuf (java.lang.String eventName, java.lang.Object msg) Returns a String which contains all details to log the Object
  LogLevel	level () Returns the LogLevel that this handler uses to log
  void	userEventTriggered (ChannelHandlerContext ctx, java.lang.Object evt) Calls ChannelHandlerContext.fireUserEventTriggered(Object) to forward to the next ChannelInboundHandler in the ChannelPipeline.
  void	write (ChannelHandlerContext ctx, java.lang.Object msg, ChannelPromise promise) Calls ChannelHandlerContext.write(Object, ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.

  • Methods inherited from class io.netty.channel.ChannelDuplexHandler

    read

  • 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

• Field Detail

  • logger

    protected final io.netty.util.internal.logging.InternalLogger logger

  • internalLevel

    protected final io.netty.util.internal.logging.InternalLogLevel internalLevel

• Constructor Detail

  • LoggingHandler

    public LoggingHandler()

    Creates a new instance whose logger name is the fully qualified class name of the instance with hex dump enabled.

  • LoggingHandler

    public LoggingHandler(LogLevel level)

    Creates a new instance whose logger name is the fully qualified class name of the instance.

    Parameters:

    level - the log level

  • LoggingHandler

    public LoggingHandler(java.lang.Class<?> clazz)

    Creates a new instance with the specified logger name and with hex dump enabled.

  • LoggingHandler

    public LoggingHandler(java.lang.Class<?> clazz,
     LogLevel level)

    Creates a new instance with the specified logger name.

    Parameters:

    level - the log level

  • LoggingHandler

    public LoggingHandler(java.lang.String name)

    Creates a new instance with the specified logger name.

  • LoggingHandler

    public LoggingHandler(java.lang.String name,
     LogLevel level)

    Creates a new instance with the specified logger name.

    Parameters:

    level - the log level

• Method Detail

  • level

    public LogLevel level()

    Returns the LogLevel that this handler uses to log

  • format

    protected java.lang.String format(ChannelHandlerContext ctx,
     java.lang.String message)

  • channelRegistered

    public void channelRegistered(ChannelHandlerContext ctx)
     throws java.lang.Exception

    Description copied from class: ChannelInboundHandlerAdapter
    Calls ChannelHandlerContext.fireChannelRegistered() to forward to the next ChannelInboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

    Specified by:

    channelRegistered in interface ChannelInboundHandler

    Overrides:

    channelRegistered in class ChannelInboundHandlerAdapter

    Throws:

    java.lang.Exception

  • channelUnregistered

    public void channelUnregistered(ChannelHandlerContext ctx)
     throws java.lang.Exception

    Description copied from class: ChannelInboundHandlerAdapter
    Calls ChannelHandlerContext.fireChannelUnregistered() to forward to the next ChannelInboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

    Specified by:

    channelUnregistered in interface ChannelInboundHandler

    Overrides:

    channelUnregistered in class ChannelInboundHandlerAdapter

    Throws:

    java.lang.Exception

  • channelActive

    public void channelActive(ChannelHandlerContext ctx)
     throws java.lang.Exception

    Description copied from class: ChannelInboundHandlerAdapter
    Calls ChannelHandlerContext.fireChannelActive() to forward to the next ChannelInboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

    Specified by:

    channelActive in interface ChannelInboundHandler

    Overrides:

    channelActive in class ChannelInboundHandlerAdapter

    Throws:

    java.lang.Exception

  • channelInactive

    public void channelInactive(ChannelHandlerContext ctx)
     throws java.lang.Exception

    Description copied from class: ChannelInboundHandlerAdapter
    Calls ChannelHandlerContext.fireChannelInactive() to forward to the next ChannelInboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

    Specified by:

    channelInactive in interface ChannelInboundHandler

    Overrides:

    channelInactive in class ChannelInboundHandlerAdapter

    Throws:

    java.lang.Exception

  • exceptionCaught

    public void exceptionCaught(ChannelHandlerContext ctx,
     java.lang.Throwable cause)
     throws java.lang.Exception

    Description copied from class: ChannelInboundHandlerAdapter
    Calls ChannelHandlerContext.fireExceptionCaught(Throwable) to forward to the next ChannelHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

    Specified by:

    exceptionCaught in interface ChannelHandler

    Specified by:

    exceptionCaught in interface ChannelInboundHandler

    Overrides:

    exceptionCaught in class ChannelInboundHandlerAdapter

    Throws:

    java.lang.Exception

  • userEventTriggered

    public void userEventTriggered(ChannelHandlerContext ctx,
     java.lang.Object evt)
     throws java.lang.Exception

    Description copied from class: ChannelInboundHandlerAdapter
    Calls ChannelHandlerContext.fireUserEventTriggered(Object) to forward to the next ChannelInboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

    Specified by:

    userEventTriggered in interface ChannelInboundHandler

    Overrides:

    userEventTriggered in class ChannelInboundHandlerAdapter

    Throws:

    java.lang.Exception

  • bind

    public void bind(ChannelHandlerContext ctx,
     java.net.SocketAddress localAddress,
     ChannelPromise promise)
     throws java.lang.Exception

    Description copied from class: ChannelDuplexHandler
    Calls ChannelHandlerContext.bind(SocketAddress, ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

    Specified by:

    bind in interface ChannelOutboundHandler

    Overrides:

    bind in class ChannelDuplexHandler

    Parameters:

    ctx - the ChannelHandlerContext for which the bind operation is made

    localAddress - the SocketAddress to which it should bound

    promise - the ChannelPromise to notify once the operation completes

    Throws:

    java.lang.Exception - thrown if an error occurs

  • connect

    public void connect(ChannelHandlerContext ctx,
     java.net.SocketAddress remoteAddress,
     java.net.SocketAddress localAddress,
     ChannelPromise promise)
     throws java.lang.Exception

    Description copied from class: ChannelDuplexHandler
    Calls ChannelHandlerContext.connect(SocketAddress, SocketAddress, ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

    Specified by:

    connect in interface ChannelOutboundHandler

    Overrides:

    connect in class ChannelDuplexHandler

    Parameters:

    ctx - the ChannelHandlerContext for which the connect operation is made

    remoteAddress - the SocketAddress to which it should connect

    localAddress - the SocketAddress which is used as source on connect

    promise - the ChannelPromise to notify once the operation completes

    Throws:

    java.lang.Exception - thrown if an error occurs

  • disconnect

    public void disconnect(ChannelHandlerContext ctx,
     ChannelPromise promise)
     throws java.lang.Exception

    Description copied from class: ChannelDuplexHandler
    Calls ChannelHandlerContext.disconnect(ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

    Specified by:

    disconnect in interface ChannelOutboundHandler

    Overrides:

    disconnect in class ChannelDuplexHandler

    Parameters:

    ctx - the ChannelHandlerContext for which the disconnect operation is made

    promise - the ChannelPromise to notify once the operation completes

    Throws:

    java.lang.Exception - thrown if an error occurs

  • close

    public void close(ChannelHandlerContext ctx,
     ChannelPromise promise)
     throws java.lang.Exception

    Description copied from class: ChannelDuplexHandler
    Calls ChannelHandlerContext.close(ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

    Specified by:

    close in interface ChannelOutboundHandler

    Overrides:

    close in class ChannelDuplexHandler

    Parameters:

    ctx - the ChannelHandlerContext for which the close operation is made

    promise - the ChannelPromise to notify once the operation completes

    Throws:

    java.lang.Exception - thrown if an error occurs

  • deregister

    public void deregister(ChannelHandlerContext ctx,
     ChannelPromise promise)
     throws java.lang.Exception

    Description copied from class: ChannelDuplexHandler
    Calls ChannelHandlerContext.close(ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

    Specified by:

    deregister in interface ChannelOutboundHandler

    Overrides:

    deregister in class ChannelDuplexHandler

    Parameters:

    ctx - the ChannelHandlerContext for which the close operation is made

    promise - the ChannelPromise to notify once the operation completes

    Throws:

    java.lang.Exception - thrown if an error occurs

  • channelReadComplete

    public void channelReadComplete(ChannelHandlerContext ctx)
     throws java.lang.Exception

    Description copied from class: ChannelInboundHandlerAdapter
    Calls ChannelHandlerContext.fireChannelReadComplete() to forward to the next ChannelInboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

    Specified by:

    channelReadComplete in interface ChannelInboundHandler

    Overrides:

    channelReadComplete in class ChannelInboundHandlerAdapter

    Throws:

    java.lang.Exception

  • channelRead

    public void channelRead(ChannelHandlerContext ctx,
     java.lang.Object msg)
     throws java.lang.Exception

    Description copied from class: ChannelInboundHandlerAdapter
    Calls ChannelHandlerContext.fireChannelRead(Object) to forward to the next ChannelInboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

    Specified by:

    channelRead in interface ChannelInboundHandler

    Overrides:

    channelRead in class ChannelInboundHandlerAdapter

    Throws:

    java.lang.Exception

  • write

    public void write(ChannelHandlerContext ctx,
     java.lang.Object msg,
     ChannelPromise promise)
     throws java.lang.Exception

    Description copied from class: ChannelDuplexHandler
    Calls ChannelHandlerContext.write(Object, ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

    Specified by:

    write in interface ChannelOutboundHandler

    Overrides:

    write in class ChannelDuplexHandler

    Parameters:

    ctx - the ChannelHandlerContext for which the write operation is made

    msg - the message to write

    promise - the ChannelPromise to notify once the operation completes

    Throws:

    java.lang.Exception - thrown if an error occurs

  • channelWritabilityChanged

    public void channelWritabilityChanged(ChannelHandlerContext ctx)
     throws java.lang.Exception

    Description copied from class: ChannelInboundHandlerAdapter
    Calls ChannelHandlerContext.fireChannelWritabilityChanged() to forward to the next ChannelInboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

    Specified by:

    channelWritabilityChanged in interface ChannelInboundHandler

    Overrides:

    channelWritabilityChanged in class ChannelInboundHandlerAdapter

    Throws:

    java.lang.Exception

  • flush

    public void flush(ChannelHandlerContext ctx)
     throws java.lang.Exception

    Description copied from class: ChannelDuplexHandler
    Calls ChannelHandlerContext.flush() to forward to the next ChannelOutboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

    Specified by:

    flush in interface ChannelOutboundHandler

    Overrides:

    flush in class ChannelDuplexHandler

    Parameters:

    ctx - the ChannelHandlerContext for which the flush operation is made

    Throws:

    java.lang.Exception - thrown if an error occurs

  • formatMessage

    protected java.lang.String formatMessage(java.lang.String eventName,
     java.lang.Object msg)

  • formatByteBuf

    protected java.lang.String formatByteBuf(java.lang.String eventName,
     ByteBuf msg)

    Returns a String which contains all details to log the ByteBuf

  • formatNonByteBuf

    protected java.lang.String formatNonByteBuf(java.lang.String eventName,
     java.lang.Object msg)

    Returns a String which contains all details to log the Object

  • formatByteBufHolder

    protected java.lang.String formatByteBufHolder(java.lang.String eventName,
     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.