LoggingHandler (Netty API Reference (4.1.22.Final))

java.lang.Object
- io.netty.channel.ChannelHandlerAdapter
- - io.netty.channel.ChannelInboundHandlerAdapter
  - - io.netty.channel.ChannelDuplexHandler
    - - io.netty.handler.logging.LoggingHandler

All Implemented Interfaces:

ChannelHandler ， ChannelInboundHandler ， ChannelOutboundHandler
```
@ChannelHandler.Sharable
public class LoggingHandler
extends ChannelDuplexHandler
```
一个使用日志框架记录所有事件的ChannelHandler 。默认情况下，所有事件都记录在DEBUG级别。

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 and Description
`LoggingHandler()` 创建一个新的实例，其记录器名称是启用了十六进制转储的实例的完全限定类名称。
`LoggingHandler(java.lang.Class<?> clazz)` 使用指定的记录器名称和启用十六进制转储创建新实例。
`LoggingHandler(java.lang.Class<?> clazz, LogLevel level)` 用指定的记录器名称创建一个新实例。
`LoggingHandler(LogLevel level)` 创建一个新的实例，其记录器名称是实例的完全限定类名称。
`LoggingHandler(java.lang.String name)` 使用默认日志级别创建具有指定记录器名称的新实例。
`LoggingHandler(java.lang.String name, LogLevel level)` 用指定的记录器名称创建一个新实例。

方法摘要

所有方法接口方法具体的方法
Modifier and Type	Method and Description
`void`	`bind(ChannelHandlerContext ctx, java.net.SocketAddress localAddress, ChannelPromise promise)` 致电`ChannelOutboundInvoker.bind(SocketAddress, ChannelPromise)`转发到`ChannelPipeline`中的下一个`ChannelOutboundHandler` 。
`void`	`channelActive(ChannelHandlerContext ctx)` 致电`ChannelHandlerContext.fireChannelActive()`转发到`ChannelPipeline`中的下一个`ChannelInboundHandler` 。
`void`	`channelInactive(ChannelHandlerContext ctx)` 致电`ChannelHandlerContext.fireChannelInactive()`转发到`ChannelPipeline`中的下一个`ChannelInboundHandler` 。
`void`	`channelRead(ChannelHandlerContext ctx, java.lang.Object msg)` 致电`ChannelHandlerContext.fireChannelRead(Object)`转发到`ChannelPipeline`中的下一个`ChannelInboundHandler` 。
`void`	`channelReadComplete(ChannelHandlerContext ctx)` 致电`ChannelHandlerContext.fireChannelReadComplete()`转发到`ChannelPipeline`中的下一个`ChannelInboundHandler` 。
`void`	`channelRegistered(ChannelHandlerContext ctx)` 致电`ChannelHandlerContext.fireChannelRegistered()`转发到`ChannelPipeline`中的下一个`ChannelInboundHandler` 。
`void`	`channelUnregistered(ChannelHandlerContext ctx)` 致电`ChannelHandlerContext.fireChannelUnregistered()`转发到82624744483597中的下一个`ChannelInboundHandler` 。
`void`	`channelWritabilityChanged(ChannelHandlerContext ctx)` 致电`ChannelHandlerContext.fireChannelWritabilityChanged()`转发到下一个`ChannelInboundHandler`的`ChannelPipeline` 。
`void`	`close(ChannelHandlerContext ctx, ChannelPromise promise)` 致电`ChannelOutboundInvoker.close(ChannelPromise)`转发到`ChannelPipeline`中的下一个`ChannelOutboundHandler` 。
`void`	`connect(ChannelHandlerContext ctx, java.net.SocketAddress remoteAddress, java.net.SocketAddress localAddress, ChannelPromise promise)` 致电`ChannelOutboundInvoker.connect(SocketAddress, SocketAddress, ChannelPromise)`转发到`ChannelPipeline`中的下一个`ChannelOutboundHandler` 。
`void`	`deregister(ChannelHandlerContext ctx, ChannelPromise promise)` 致电`ChannelOutboundInvoker.close(ChannelPromise)`转发到82624794525206中的下一个`ChannelOutboundHandler` 。
`void`	`disconnect(ChannelHandlerContext ctx, ChannelPromise promise)` 致电`ChannelOutboundInvoker.disconnect(ChannelPromise)`转发到`ChannelPipeline`中的下一个`ChannelOutboundHandler` 。
`void`	`exceptionCaught(ChannelHandlerContext ctx, java.lang.Throwable cause)` 致电`ChannelHandlerContext.fireExceptionCaught(Throwable)`转发至`ChannelPipeline`中的下一个`ChannelHandler` 。
`void`	`flush(ChannelHandlerContext ctx)` 致电`ChannelHandlerContext.flush()`转发到`ChannelPipeline`中的下一个`ChannelOutboundHandler` 。
`protected java.lang.String`	`format(ChannelHandlerContext ctx, java.lang.String eventName)` 格式化事件并返回格式化的消息。
`protected java.lang.String`	`format(ChannelHandlerContext ctx, java.lang.String eventName, java.lang.Object arg)` 格式化事件并返回格式化的消息。
`protected java.lang.String`	`format(ChannelHandlerContext ctx, java.lang.String eventName, java.lang.Object firstArg, java.lang.Object secondArg)` 格式化事件并返回格式化的消息。
`LogLevel`	`level()` 返回此处理程序用于记录的`LogLevel`
`void`	`userEventTriggered(ChannelHandlerContext ctx, java.lang.Object evt)` 致电`ChannelHandlerContext.fireUserEventTriggered(Object)`转发到`ChannelPipeline`中的下一个`ChannelInboundHandler` 。
`void`	`write(ChannelHandlerContext ctx, java.lang.Object msg, ChannelPromise promise)` 致电`ChannelOutboundInvoker.write(Object, ChannelPromise)`转发到`ChannelPipeline`中的下一个`ChannelOutboundHandler` 。

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

- 字段详细信息
  - logger
```
protected final io.netty.util.internal.logging.InternalLogger logger
```
  - internalLevel
```
protected final io.netty.util.internal.logging.InternalLogLevel internalLevel
```
- 构造方法详细信息
  - LoggingHandler
```
public LoggingHandler()
```
    创建一个新的实例，其记录器名称是启用了十六进制转储的实例的完全限定类名称。
  - LoggingHandler
```
public LoggingHandler(LogLevel level)
```
    创建一个新的实例，其记录器名称是实例的完全限定类名称。
    
    参数
    
    level - 日志级别
  - LoggingHandler
```
public LoggingHandler(java.lang.Class<?> clazz)
```
    使用指定的记录器名称和启用十六进制转储创建新实例。
    
    参数
    
    clazz - 生成记录器的类类型
  - LoggingHandler
```
public LoggingHandler(java.lang.Class<?> clazz,
                      LogLevel level)
```
    用指定的记录器名称创建一个新实例。
    
    参数
    
    clazz - 生成记录器的类类型
    
    level - 日志级别
  - LoggingHandler
```
public LoggingHandler(java.lang.String name)
```
    使用默认日志级别创建具有指定记录器名称的新实例。
    
    参数
    
    name - 用于记录器的类的名称
  - LoggingHandler
```
public LoggingHandler(java.lang.String name,
                      LogLevel level)
```
    用指定的记录器名称创建一个新实例。
    
    参数
    
    name - 用于记录器的类的名称
    
    level - 日志级别
- 方法详细信息
  - level
```
public LogLevel level()
```
    返回此处理程序用于记录的LogLevel
  - channelRegistered
```
public void channelRegistered(ChannelHandlerContext ctx)
                       throws java.lang.Exception
```
    从类复制的描述： ChannelInboundHandlerAdapter
    
    致电ChannelHandlerContext.fireChannelRegistered()转发到ChannelPipeline中的下一个ChannelInboundHandler 。子类可以重写此方法来更改行为。
    
    Specified by:
    
    channelRegistered在界面 ChannelInboundHandler
    
    重写：
    
    channelRegistered在课堂上 ChannelInboundHandlerAdapter
    
    异常
    
    java.lang.Exception
  - channelUnregistered
```
public void channelUnregistered(ChannelHandlerContext ctx)
                         throws java.lang.Exception
```
    从类复制的描述： ChannelInboundHandlerAdapter
    
    致电ChannelHandlerContext.fireChannelUnregistered()转发到ChannelPipeline中的下一个ChannelInboundHandler 。子类可以重写此方法来更改行为。
    
    Specified by:
    
    channelUnregistered在界面 ChannelInboundHandler
    
    重写：
    
    channelUnregistered在课堂上 ChannelInboundHandlerAdapter
    
    异常
    
    java.lang.Exception
  - channelActive
```
public void channelActive(ChannelHandlerContext ctx)
                   throws java.lang.Exception
```
    从类复制的描述： ChannelInboundHandlerAdapter
    
    致电ChannelHandlerContext.fireChannelActive()转发到ChannelPipeline中的下一个ChannelInboundHandler 。子类可以重写此方法来更改行为。
    
    Specified by:
    
    channelActive ，界面 ChannelInboundHandler
    
    重写：
    
    channelActive在课堂上 ChannelInboundHandlerAdapter
    
    异常
    
    java.lang.Exception
  - channelInactive
```
public void channelInactive(ChannelHandlerContext ctx)
                     throws java.lang.Exception
```
    从类复制的描述： ChannelInboundHandlerAdapter
    
    致电ChannelHandlerContext.fireChannelInactive()转发到ChannelPipeline中的下一个ChannelInboundHandler 。子类可以重写此方法来更改行为。
    
    Specified by:
    
    channelInactive在界面 ChannelInboundHandler
    
    重写：
    
    channelInactive在课堂上 ChannelInboundHandlerAdapter
    
    异常
    
    java.lang.Exception
  - exceptionCaught
```
public void exceptionCaught(ChannelHandlerContext ctx,
                            java.lang.Throwable cause)
                     throws java.lang.Exception
```
    从类复制的描述： ChannelInboundHandlerAdapter
    
    致电ChannelHandlerContext.fireExceptionCaught(Throwable)转发到ChannelPipeline中的下一个ChannelHandler 。子类可以重写此方法来更改行为。
    
    Specified by:
    
    exceptionCaught在界面 ChannelHandler
    
    Specified by:
    
    exceptionCaught在界面 ChannelInboundHandler
    
    重写：
    
    exceptionCaught在课堂上 ChannelInboundHandlerAdapter
    
    异常
    
    java.lang.Exception
  - userEventTriggered
```
public void userEventTriggered(ChannelHandlerContext ctx,
                               java.lang.Object evt)
                        throws java.lang.Exception
```
    从类复制的描述： ChannelInboundHandlerAdapter
    
    致电ChannelHandlerContext.fireUserEventTriggered(Object)转发到ChannelPipeline中的下一个ChannelInboundHandler 。子类可以重写此方法来更改行为。
    
    Specified by:
    
    userEventTriggered在界面 ChannelInboundHandler
    
    重写：
    
    userEventTriggered在课堂上 ChannelInboundHandlerAdapter
    
    异常
    
    java.lang.Exception
  - bind
```
public void bind(ChannelHandlerContext ctx,
                 java.net.SocketAddress localAddress,
                 ChannelPromise promise)
          throws java.lang.Exception
```
    从类复制的描述： ChannelDuplexHandler
    
    致电ChannelOutboundInvoker.bind(SocketAddress, ChannelPromise)转发到ChannelPipeline中的下一个ChannelOutboundHandler 。子类可以重写此方法来更改行为。
    
    Specified by:
    
    bind ，界面 ChannelOutboundHandler
    
    重写：
    
    bind在课堂上 ChannelDuplexHandler
    
    参数
    
    ctx - 进行绑定操作的ChannelHandlerContext
    
    localAddress - 它应该绑定的 SocketAddress
    
    promise - 在操作完成后通知ChannelPromise
    
    异常
    
    java.lang.Exception - 发生错误时抛出
  - connect
```
public void connect(ChannelHandlerContext ctx,
                    java.net.SocketAddress remoteAddress,
                    java.net.SocketAddress localAddress,
                    ChannelPromise promise)
             throws java.lang.Exception
```
    从类复制的描述： ChannelDuplexHandler
    
    致电ChannelOutboundInvoker.connect(SocketAddress, SocketAddress, ChannelPromise)转发到ChannelPipeline中的下一个ChannelOutboundHandler 。子类可以重写此方法来更改行为。
    
    Specified by:
    
    connect ，界面 ChannelOutboundHandler
    
    重写：
    
    connect ChannelDuplexHandler
    
    参数
    
    ctx - 进行连接操作的ChannelHandlerContext
    
    remoteAddress - 它应该连接到的 SocketAddress
    
    localAddress - 用作连接源的 SocketAddress
    
    promise - 在操作完成后通知ChannelPromise
    
    异常
    
    java.lang.Exception - 发生错误时抛出
  - disconnect
```
public void disconnect(ChannelHandlerContext ctx,
                       ChannelPromise promise)
                throws java.lang.Exception
```
    从类复制的描述： ChannelDuplexHandler
    
    致电ChannelOutboundInvoker.disconnect(ChannelPromise)转发到ChannelPipeline中的下一个ChannelOutboundHandler 。子类可以重写此方法来更改行为。
    
    Specified by:
    
    disconnect在界面 ChannelOutboundHandler
    
    重写：
    
    disconnect在课堂上 ChannelDuplexHandler
    
    参数
    
    ctx - 为其进行断开操作的ChannelHandlerContext
    
    promise - 在操作完成后通知ChannelPromise
    
    异常
    
    java.lang.Exception - 发生错误时抛出
  - close
```
public void close(ChannelHandlerContext ctx,
                  ChannelPromise promise)
           throws java.lang.Exception
```
    从类复制的描述： ChannelDuplexHandler
    
    致电ChannelOutboundInvoker.close(ChannelPromise)转发到ChannelPipeline中的下一个ChannelOutboundHandler 。子类可以重写此方法来更改行为。
    
    Specified by:
    
    close ，界面 ChannelOutboundHandler
    
    重写：
    
    close在课堂上 ChannelDuplexHandler
    
    参数
    
    ctx - 关闭操作的ChannelHandlerContext
    
    promise - 在操作完成后通知ChannelPromise
    
    异常
    
    java.lang.Exception - 发生错误时抛出
  - deregister
```
public void deregister(ChannelHandlerContext ctx,
                       ChannelPromise promise)
                throws java.lang.Exception
```
    从类复制的描述： ChannelDuplexHandler
    
    致电ChannelOutboundInvoker.close(ChannelPromise)转发到ChannelPipeline中的下一个ChannelOutboundHandler 。子类可以重写此方法来更改行为。
    
    Specified by:
    
    deregister接口 ChannelOutboundHandler
    
    重写：
    
    deregister在课堂上 ChannelDuplexHandler
    
    参数
    
    ctx - 关闭操作的ChannelHandlerContext
    
    promise - 在操作完成后通知ChannelPromise
    
    异常
    
    java.lang.Exception - 发生错误时抛出
  - channelReadComplete
```
public void channelReadComplete(ChannelHandlerContext ctx)
                         throws java.lang.Exception
```
    从类复制的描述： ChannelInboundHandlerAdapter
    
    致电ChannelHandlerContext.fireChannelReadComplete()转发到ChannelPipeline中的下一个ChannelInboundHandler 。子类可以重写此方法来更改行为。
    
    Specified by:
    
    channelReadComplete ，界面 ChannelInboundHandler
    
    重写：
    
    channelReadComplete在课堂上 ChannelInboundHandlerAdapter
    
    异常
    
    java.lang.Exception
  - channelRead
```
public void channelRead(ChannelHandlerContext ctx,
                        java.lang.Object msg)
                 throws java.lang.Exception
```
    从类复制的描述： ChannelInboundHandlerAdapter
    
    致电ChannelHandlerContext.fireChannelRead(Object)转发到ChannelPipeline中的下一个ChannelInboundHandler 。子类可以重写此方法来更改行为。
    
    Specified by:
    
    channelRead ，界面 ChannelInboundHandler
    
    重写：
    
    channelRead在课堂上 ChannelInboundHandlerAdapter
    
    异常
    
    java.lang.Exception
  - write
```
public void write(ChannelHandlerContext ctx,
                  java.lang.Object msg,
                  ChannelPromise promise)
           throws java.lang.Exception
```
    从类复制的描述： ChannelDuplexHandler
    
    致电ChannelOutboundInvoker.write(Object, ChannelPromise)转发到ChannelPipeline中的下一个ChannelOutboundHandler 。子类可以重写此方法来更改行为。
    
    Specified by:
    
    write在界面 ChannelOutboundHandler
    
    重写：
    
    write在课堂上 ChannelDuplexHandler
    
    参数
    
    ctx - 为其写入操作的ChannelHandlerContext
    
    msg - 写信息
    
    promise - 操作完成后通知ChannelPromise
    
    异常
    
    java.lang.Exception - 发生错误时抛出
  - channelWritabilityChanged
```
public void channelWritabilityChanged(ChannelHandlerContext ctx)
                               throws java.lang.Exception
```
    从类复制的描述： ChannelInboundHandlerAdapter
    
    致电ChannelHandlerContext.fireChannelWritabilityChanged()转发到ChannelPipeline中的下一个ChannelInboundHandler 。子类可以重写此方法来更改行为。
    
    Specified by:
    
    channelWritabilityChanged在界面 ChannelInboundHandler
    
    重写：
    
    channelWritabilityChanged在课堂上 ChannelInboundHandlerAdapter
    
    异常
    
    java.lang.Exception
  - flush
```
public void flush(ChannelHandlerContext ctx)
           throws java.lang.Exception
```
    从类复制的描述： ChannelDuplexHandler
    
    致电ChannelHandlerContext.flush()转发到ChannelPipeline中的下一个ChannelOutboundHandler 。子类可以重写此方法来更改行为。
    
    Specified by:
    
    flush ，界面 ChannelOutboundHandler
    
    重写：
    
    flush在课堂上 ChannelDuplexHandler
    
    参数
    
    ctx - 进行冲洗操作的ChannelHandlerContext
    
    异常
    
    java.lang.Exception - 发生错误时抛出
  - format
```
protected java.lang.String format(ChannelHandlerContext ctx,
                                  java.lang.String eventName)
```
    格式化事件并返回格式化的消息。
    
    参数
    
    eventName - 活动的名称
  - format
```
protected java.lang.String format(ChannelHandlerContext ctx,
                                  java.lang.String eventName,
                                  java.lang.Object arg)
```
    格式化事件并返回格式化的消息。
    
    参数
    
    eventName - 活动的名称
    
    arg - 事件的论据
  - format
```
protected java.lang.String format(ChannelHandlerContext ctx,
                                  java.lang.String eventName,
                                  java.lang.Object firstArg,
                                  java.lang.Object secondArg)
```
    格式化事件并返回格式化的消息。此方法目前仅用于格式化ChannelOutboundHandler.connect(ChannelHandlerContext, SocketAddress, SocketAddress, ChannelPromise) 。
    
    参数
    
    eventName - 活动的名称
    
    firstArg - 这个事件的第一个论点
    
    secondArg - 事件的第二个参数

Class LoggingHandler

Nested Class Summary

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

Field Summary

构造方法摘要

方法摘要

Methods inherited from class io.netty.channel.ChannelDuplexHandler

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

Methods inherited from class java.lang.Object

Methods inherited from interface io.netty.channel.ChannelHandler

字段详细信息

logger

internalLevel

构造方法详细信息

LoggingHandler

LoggingHandler

LoggingHandler

LoggingHandler

LoggingHandler

LoggingHandler

方法详细信息

level

channelRegistered

channelUnregistered

channelActive

channelInactive

exceptionCaught

userEventTriggered

bind

connect

disconnect

close

deregister

channelReadComplete

channelRead

write

channelWritabilityChanged

flush

format

format

format