Netty/Handler 4.1.107.Final · io.netty.handler.logging.LoggingHandler

Modifier and Type	Field and Description
private final ByteBufFormat	byteBufFormat
private static final LogLevel	DEFAULT_LEVEL
protected final InternalLogLevel	internalLevel
private final LogLevel	level
protected final InternalLogger	logger

Access	Constructor and Description
public	LoggingHandler() Creates a new instance whose logger name is the fully qualified class name of the instance with hex dump enabled.
public	LoggingHandler(ByteBufFormat Format of ByteBuf dumping format) Creates a new instance whose logger name is the fully qualified class name of the instance.
public	LoggingHandler(LogLevel the log level level) Creates a new instance whose logger name is the fully qualified class name of the instance.
public	LoggingHandler(LogLevel the log level level, ByteBufFormat the ByteBuf format byteBufFormat) Creates a new instance whose logger name is the fully qualified class name of the instance.
public	LoggingHandler(Class<?> the class type to generate the logger for clazz) Creates a new instance with the specified logger name and with hex dump enabled.
public	LoggingHandler(Class<?> the class type to generate the logger for clazz, LogLevel the log level level) Creates a new instance with the specified logger name.
public	LoggingHandler(Class<?> the class type to generate the logger for clazz, LogLevel the log level level, ByteBufFormat the ByteBuf format byteBufFormat) Creates a new instance with the specified logger name.
public	LoggingHandler(String the name of the class to use for the logger name) Creates a new instance with the specified logger name using the default log level.
public	LoggingHandler(String the name of the class to use for the logger name, LogLevel the log level level) Creates a new instance with the specified logger name.
public	LoggingHandler(String the name of the class to use for the logger name, LogLevel the log level level, ByteBufFormat the ByteBuf format byteBufFormat) Creates a new instance with the specified logger name.

Method Summary

Modifier and Type	Method and Description
public void	bind(ChannelHandlerContext the `ChannelHandlerContext` for which the bind operation is made ctx, SocketAddress the `SocketAddress` to which it should bound localAddress, ChannelPromise the `ChannelPromise` to notify once the operation completes promise) Overrides io.netty.channel.ChannelDuplexHandler.bind. Implements io.netty.channel.ChannelOutboundHandler.bind. Calls `ChannelHandlerContext#bind(SocketAddress, ChannelPromise)` to forward to the next `ChannelOutboundHandler` in the `ChannelPipeline`.
public ByteBufFormat	byteBufFormat() Returns the `ByteBufFormat` that this handler uses to log
public void	channelActive(ChannelHandlerContext ctx) Overrides io.netty.channel.ChannelInboundHandlerAdapter.channelActive. Implements io.netty.channel.ChannelInboundHandler.channelActive. Calls `ChannelHandlerContext#fireChannelActive()` to forward to the next `ChannelInboundHandler` in the `ChannelPipeline`.
public void	channelInactive(ChannelHandlerContext ctx) Overrides io.netty.channel.ChannelInboundHandlerAdapter.channelInactive. Implements io.netty.channel.ChannelInboundHandler.channelInactive. Calls `ChannelHandlerContext#fireChannelInactive()` to forward to the next `ChannelInboundHandler` in the `ChannelPipeline`.
public void	channelRead(ChannelHandlerContext ctx, Object msg) Overrides io.netty.channel.ChannelInboundHandlerAdapter.channelRead. Implements io.netty.channel.ChannelInboundHandler.channelRead. Calls `ChannelHandlerContext#fireChannelRead(Object)` to forward to the next `ChannelInboundHandler` in the `ChannelPipeline`.
public void	channelReadComplete(ChannelHandlerContext ctx) Overrides io.netty.channel.ChannelInboundHandlerAdapter.channelReadComplete. Implements io.netty.channel.ChannelInboundHandler.channelReadComplete. Calls `ChannelHandlerContext#fireChannelReadComplete()` to forward to the next `ChannelInboundHandler` in the `ChannelPipeline`.
public void	channelRegistered(ChannelHandlerContext ctx) Overrides io.netty.channel.ChannelInboundHandlerAdapter.channelRegistered. Implements io.netty.channel.ChannelInboundHandler.channelRegistered. Calls `ChannelHandlerContext#fireChannelRegistered()` to forward to the next `ChannelInboundHandler` in the `ChannelPipeline`.
public void	channelUnregistered(ChannelHandlerContext ctx) Overrides io.netty.channel.ChannelInboundHandlerAdapter.channelUnregistered. Implements io.netty.channel.ChannelInboundHandler.channelUnregistered. Calls `ChannelHandlerContext#fireChannelUnregistered()` to forward to the next `ChannelInboundHandler` in the `ChannelPipeline`.
public void	channelWritabilityChanged(ChannelHandlerContext ctx) Overrides io.netty.channel.ChannelInboundHandlerAdapter.channelWritabilityChanged. Implements io.netty.channel.ChannelInboundHandler.channelWritabilityChanged. Calls `ChannelHandlerContext#fireChannelWritabilityChanged()` to forward to the next `ChannelInboundHandler` in the `ChannelPipeline`.
public void	close(ChannelHandlerContext the `ChannelHandlerContext` for which the close operation is made ctx, ChannelPromise the `ChannelPromise` to notify once the operation completes promise) Overrides io.netty.channel.ChannelDuplexHandler.close. Implements io.netty.channel.ChannelOutboundHandler.close. Calls `ChannelHandlerContext#close(ChannelPromise)` to forward to the next `ChannelOutboundHandler` in the `ChannelPipeline`.
public void	connect(ChannelHandlerContext the `ChannelHandlerContext` for which the connect operation is made ctx, SocketAddress the `SocketAddress` to which it should connect remoteAddress, SocketAddress the `SocketAddress` which is used as source on connect localAddress, ChannelPromise the `ChannelPromise` to notify once the operation completes promise) Overrides io.netty.channel.ChannelDuplexHandler.connect. Implements io.netty.channel.ChannelOutboundHandler.connect. Calls `ChannelHandlerContext#connect(SocketAddress, SocketAddress, ChannelPromise)` to forward to the next `ChannelOutboundHandler` in the `ChannelPipeline`.
public void	deregister(ChannelHandlerContext the `ChannelHandlerContext` for which the close operation is made ctx, ChannelPromise the `ChannelPromise` to notify once the operation completes promise) Overrides io.netty.channel.ChannelDuplexHandler.deregister. Implements io.netty.channel.ChannelOutboundHandler.deregister. Calls `ChannelHandlerContext#deregister(ChannelPromise)` to forward to the next `ChannelOutboundHandler` in the `ChannelPipeline`.
public void	disconnect(ChannelHandlerContext the `ChannelHandlerContext` for which the disconnect operation is made ctx, ChannelPromise the `ChannelPromise` to notify once the operation completes promise) Overrides io.netty.channel.ChannelDuplexHandler.disconnect. Implements io.netty.channel.ChannelOutboundHandler.disconnect. Calls `ChannelHandlerContext#disconnect(ChannelPromise)` to forward to the next `ChannelOutboundHandler` in the `ChannelPipeline`.
public void	exceptionCaught(ChannelHandlerContext ctx, Throwable cause) Overrides io.netty.channel.ChannelInboundHandlerAdapter.exceptionCaught. Implements io.netty.channel.ChannelHandler.exceptionCaught, io.netty.channel.ChannelInboundHandler.exceptionCaught. Gets called if a `Throwable` was thrown.
public void	flush(ChannelHandlerContext the `ChannelHandlerContext` for which the flush operation is made ctx) Overrides io.netty.channel.ChannelDuplexHandler.flush. Implements io.netty.channel.ChannelOutboundHandler.flush. Calls `ChannelHandlerContext#flush()` to forward to the next `ChannelOutboundHandler` in the `ChannelPipeline`.
protected String	format(ChannelHandlerContext ctx, String the name of the event eventName) Formats an event and returns the formatted message.
protected String	format(ChannelHandlerContext ctx, String the name of the event eventName, Object the argument of the event arg) Formats an event and returns the formatted message.
protected String	format(ChannelHandlerContext ctx, String the name of the event eventName, Object the first argument of the event firstArg, Object the second argument of the event secondArg) Formats an event and returns the formatted message.
private String	formatByteBuf(ChannelHandlerContext ctx, String eventName, ByteBuf msg) Generates the default log message of the specified event whose argument is a `ByteBuf`.
private String	formatByteBufHolder(ChannelHandlerContext ctx, String eventName, ByteBufHolder msg) Generates the default log message of the specified event whose argument is a `ByteBufHolder`.
private static String	formatSimple(ChannelHandlerContext ctx, String eventName, Object msg) Generates the default log message of the specified event whose argument is an arbitrary object.
public LogLevel	level() Returns the `LogLevel` that this handler uses to log
public void	userEventTriggered(ChannelHandlerContext ctx, Object evt) Overrides io.netty.channel.ChannelInboundHandlerAdapter.userEventTriggered. Implements io.netty.channel.ChannelInboundHandler.userEventTriggered. Calls `ChannelHandlerContext#fireUserEventTriggered(Object)` to forward to the next `ChannelInboundHandler` in the `ChannelPipeline`.
public void	write(ChannelHandlerContext the `ChannelHandlerContext` for which the write operation is made ctx, Object the message to write msg, ChannelPromise the `ChannelPromise` to notify once the operation completes promise) Overrides io.netty.channel.ChannelDuplexHandler.write. Implements io.netty.channel.ChannelOutboundHandler.write. Calls `ChannelHandlerContext#write(Object, ChannelPromise)` to forward to the next `ChannelOutboundHandler` in the `ChannelPipeline`.

Inherited from io.netty.channel.ChannelDuplexHandler:: read

public Class LoggingHandler

Field Summary

Constructor Summary

Method Summary