1 /*
2 * Copyright 2020 The Netty Project
3 *
4 * The Netty Project licenses this file to you under the Apache License,
5 * version 2.0 (the "License"); you may not use this file except in compliance
6 * with the License. You may obtain a copy of the License at:
7 *
8 * https://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13 * License for the specific language governing permissions and limitations
14 * under the License.
15 */
16 package io.netty.handler.logging;
17
18 import io.netty.buffer.ByteBuf;
19 import io.netty.buffer.ByteBufHolder;
20 import io.netty.buffer.ByteBufUtil;
21
22 /**
23 * Used to control the format and verbosity of logging for {@link ByteBuf}s and {@link ByteBufHolder}s.
24 *
25 * @see LoggingHandler
26 */
27 public enum ByteBufFormat {
28 /**
29 * {@link ByteBuf}s will be logged in a simple format, with no hex dump included.
30 */
31 SIMPLE,
32 /**
33 * {@link ByteBuf}s will be logged using {@link ByteBufUtil#appendPrettyHexDump(StringBuilder, ByteBuf)}.
34 */
35 HEX_DUMP
36 }