001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018package org.apache.hadoop.hbase.ipc;
019
020import org.apache.yetus.audience.InterfaceAudience;
021
022import org.apache.hbase.thirdparty.io.netty.buffer.AbstractByteBufAllocator;
023import org.apache.hbase.thirdparty.io.netty.buffer.ByteBuf;
024import org.apache.hbase.thirdparty.io.netty.buffer.PooledByteBufAllocator;
025
026/**
027 * A pooled ByteBufAllocator that does not prefer direct buffers regardless of platform settings.
028 * <p>
029 * In some cases direct buffers are still required, like IO buffers where the buffer will be used in
030 * conjunction with a native method call, so we cannot force all buffer usage on heap. But we can
031 * strongly prefer it.
032 */
033@InterfaceAudience.Private
034public class HeapByteBufAllocator extends AbstractByteBufAllocator {
035
036  public static final HeapByteBufAllocator DEFAULT = new HeapByteBufAllocator();
037
038  private final PooledByteBufAllocator delegate =
039    new PooledByteBufAllocator(false /* preferDirect */);
040
041  @Override
042  public boolean isDirectBufferPooled() {
043    return delegate.isDirectBufferPooled();
044  }
045
046  @Override
047  protected ByteBuf newHeapBuffer(int initialCapacity, int maxCapacity) {
048    return delegate.heapBuffer(initialCapacity, maxCapacity);
049  }
050
051  @Override
052  protected ByteBuf newDirectBuffer(int initialCapacity, int maxCapacity) {
053    return delegate.directBuffer(initialCapacity, maxCapacity);
054  }
055
056}