1 /* 2 * Copyright 2013 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.buffer; 17 18 import io.netty.util.ReferenceCounted; 19 20 /** 21 * A packet which is send or receive. 22 */ 23 public interface ByteBufHolder extends ReferenceCounted { 24 25 /** 26 * Return the data which is held by this {@link ByteBufHolder}. 27 */ 28 ByteBuf content(); 29 30 /** 31 * Creates a deep copy of this {@link ByteBufHolder}. 32 */ 33 ByteBufHolder copy(); 34 35 /** 36 * Duplicates this {@link ByteBufHolder}. Be aware that this will not automatically call {@link #retain()}. 37 */ 38 ByteBufHolder duplicate(); 39 40 /** 41 * Duplicates this {@link ByteBufHolder}. This method returns a retained duplicate unlike {@link #duplicate()}. 42 * 43 * @see ByteBuf#retainedDuplicate() 44 */ 45 ByteBufHolder retainedDuplicate(); 46 47 /** 48 * Returns a new {@link ByteBufHolder} which contains the specified {@code content}. 49 */ 50 ByteBufHolder replace(ByteBuf content); 51 52 @Override 53 ByteBufHolder retain(); 54 55 @Override 56 ByteBufHolder retain(int increment); 57 58 @Override 59 ByteBufHolder touch(); 60 61 @Override 62 ByteBufHolder touch(Object hint); 63 }