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, 013 * software distributed under the License is distributed on an 014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 015 * KIND, either express or implied. See the License for the 016 * specific language governing permissions and limitations 017 * under the License. 018 * 019 */ 020package org.apache.mina.core.buffer; 021 022import java.nio.ByteBuffer; 023 024/** 025 * Allocates {@link IoBuffer}s and manages them. Please implement this 026 * interface if you need more advanced memory management scheme. 027 * 028 * @author <a href="http://mina.apache.org">Apache MINA Project</a> 029 */ 030public interface IoBufferAllocator { 031 /** 032 * Returns the buffer which is capable of the specified size. 033 * 034 * @param capacity the capacity of the buffer 035 * @param direct <tt>true</tt> to get a direct buffer, 036 * <tt>false</tt> to get a heap buffer. 037 * @return The allocated {@link IoBuffer} 038 */ 039 IoBuffer allocate(int capacity, boolean direct); 040 041 /** 042 * Returns the NIO buffer which is capable of the specified size. 043 * 044 * @param capacity the capacity of the buffer 045 * @param direct <tt>true</tt> to get a direct buffer, 046 * <tt>false</tt> to get a heap buffer. 047 * @return The allocated {@link ByteBuffer} 048 */ 049 ByteBuffer allocateNioBuffer(int capacity, boolean direct); 050 051 /** 052 * Wraps the specified NIO {@link ByteBuffer} into MINA buffer. 053 * 054 * @param nioBuffer The {@link ByteBuffer} to wrap 055 * @return The {@link IoBuffer} wrapping the {@link ByteBuffer} 056 */ 057 IoBuffer wrap(ByteBuffer nioBuffer); 058 059 /** 060 * Dispose of this allocator. 061 */ 062 void dispose(); 063}