io.netty.handler.logging

类 LoggingHandler

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.channel.ChannelDuplexHandler

io.netty.handler.logging.LoggingHandler

所有已实现的接口:

ChannelHandler, ChannelInboundHandler, ChannelOutboundHandler

@ChannelHandler.Sharable
public class LoggingHandler
extends ChannelDuplexHandler

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

嵌套类概要

从接口继承的嵌套类/接口 io.netty.channel.ChannelHandler

ChannelHandler.Sharable

字段概要

字段

限定符和类型	字段和说明
protected InternalLogLevel	internalLevel
protected InternalLogger	logger

构造器概要

构造器

构造器和说明
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.

方法概要

方法

限定符和类型	方法和说明
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.

从类继承的方法 io.netty.channel.ChannelDuplexHandler

read

从类继承的方法 io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, handlerAdded, handlerRemoved, isSharable

从类继承的方法 java.lang.Object

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

从接口继承的方法 io.netty.channel.ChannelHandler

handlerAdded, handlerRemoved

字段详细资料

logger

protected final InternalLogger logger

internalLevel

protected final InternalLogLevel internalLevel

构造器详细资料

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.

参数:

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.

参数:

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.

参数:

level - the log level

方法详细资料

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

从类复制的说明: ChannelInboundHandlerAdapter

Calls ChannelHandlerContext.fireChannelRegistered() to forward to the next ChannelInboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

指定者:

channelRegistered 在接口中 ChannelInboundHandler

覆盖:

channelRegistered 在类中 ChannelInboundHandlerAdapter

抛出:

java.lang.Exception

channelUnregistered

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

从类复制的说明: ChannelInboundHandlerAdapter

Calls ChannelHandlerContext.fireChannelUnregistered() to forward to the next ChannelInboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

指定者:

channelUnregistered 在接口中 ChannelInboundHandler

覆盖:

channelUnregistered 在类中 ChannelInboundHandlerAdapter

抛出:

java.lang.Exception

channelActive

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

从类复制的说明: ChannelInboundHandlerAdapter

Calls ChannelHandlerContext.fireChannelActive() to forward to the next ChannelInboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

指定者:

channelActive 在接口中 ChannelInboundHandler

覆盖:

channelActive 在类中 ChannelInboundHandlerAdapter

抛出:

java.lang.Exception

channelInactive

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

从类复制的说明: ChannelInboundHandlerAdapter

Calls ChannelHandlerContext.fireChannelInactive() to forward to the next ChannelInboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

指定者:

channelInactive 在接口中 ChannelInboundHandler

覆盖:

channelInactive 在类中 ChannelInboundHandlerAdapter

抛出:

java.lang.Exception

exceptionCaught

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

从类复制的说明: ChannelInboundHandlerAdapter

Calls ChannelHandlerContext.fireExceptionCaught(Throwable) to forward to the next ChannelHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

指定者:

exceptionCaught 在接口中 ChannelHandler

指定者:

exceptionCaught 在接口中 ChannelInboundHandler

覆盖:

exceptionCaught 在类中 ChannelInboundHandlerAdapter

抛出:

java.lang.Exception

userEventTriggered

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

从类复制的说明: ChannelInboundHandlerAdapter

Calls ChannelHandlerContext.fireUserEventTriggered(Object) to forward to the next ChannelInboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

指定者:

userEventTriggered 在接口中 ChannelInboundHandler

覆盖:

userEventTriggered 在类中 ChannelInboundHandlerAdapter

抛出:

java.lang.Exception

bind

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

从类复制的说明: ChannelDuplexHandler

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

指定者:

bind 在接口中 ChannelOutboundHandler

覆盖:

bind 在类中 ChannelDuplexHandler

参数:

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

抛出:

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

从类复制的说明: 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.

指定者:

connect 在接口中 ChannelOutboundHandler

覆盖:

connect 在类中 ChannelDuplexHandler

参数:

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

抛出:

java.lang.Exception - thrown if an error occurs

disconnect

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

从类复制的说明: ChannelDuplexHandler

Calls ChannelHandlerContext.disconnect(ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

指定者:

disconnect 在接口中 ChannelOutboundHandler

覆盖:

disconnect 在类中 ChannelDuplexHandler

参数:

ctx - the ChannelHandlerContext for which the disconnect operation is made

promise - the ChannelPromise to notify once the operation completes

抛出:

java.lang.Exception - thrown if an error occurs

close

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

从类复制的说明: ChannelDuplexHandler

Calls ChannelHandlerContext.close(ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

指定者:

close 在接口中 ChannelOutboundHandler

覆盖:

close 在类中 ChannelDuplexHandler

参数:

ctx - the ChannelHandlerContext for which the close operation is made

promise - the ChannelPromise to notify once the operation completes

抛出:

java.lang.Exception - thrown if an error occurs

deregister

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

从类复制的说明: ChannelDuplexHandler

Calls ChannelHandlerContext.close(ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

指定者:

deregister 在接口中 ChannelOutboundHandler

覆盖:

deregister 在类中 ChannelDuplexHandler

参数:

ctx - the ChannelHandlerContext for which the close operation is made

promise - the ChannelPromise to notify once the operation completes

抛出:

java.lang.Exception - thrown if an error occurs

channelReadComplete

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

从类复制的说明: ChannelInboundHandlerAdapter

Calls ChannelHandlerContext.fireChannelReadComplete() to forward to the next ChannelInboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

指定者:

channelReadComplete 在接口中 ChannelInboundHandler

覆盖:

channelReadComplete 在类中 ChannelInboundHandlerAdapter

抛出:

java.lang.Exception

channelRead

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

从类复制的说明: ChannelInboundHandlerAdapter

Calls ChannelHandlerContext.fireChannelRead(Object) to forward to the next ChannelInboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

指定者:

channelRead 在接口中 ChannelInboundHandler

覆盖:

channelRead 在类中 ChannelInboundHandlerAdapter

抛出:

java.lang.Exception

write

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

从类复制的说明: ChannelDuplexHandler

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

指定者:

write 在接口中 ChannelOutboundHandler

覆盖:

write 在类中 ChannelDuplexHandler

参数:

ctx - the ChannelHandlerContext for which the write operation is made

msg - the message to write

promise - the ChannelPromise to notify once the operation completes

抛出:

java.lang.Exception - thrown if an error occurs

channelWritabilityChanged

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

从类复制的说明: ChannelInboundHandlerAdapter

Calls ChannelHandlerContext.fireChannelWritabilityChanged() to forward to the next ChannelInboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

指定者:

channelWritabilityChanged 在接口中 ChannelInboundHandler

覆盖:

channelWritabilityChanged 在类中 ChannelInboundHandlerAdapter

抛出:

java.lang.Exception

flush

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

从类复制的说明: ChannelDuplexHandler

Calls ChannelHandlerContext.flush() to forward to the next ChannelOutboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

指定者:

flush 在接口中 ChannelOutboundHandler

覆盖:

flush 在类中 ChannelDuplexHandler

参数:

ctx - the ChannelHandlerContext for which the flush operation is made

抛出:

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.