01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one
03: * or more contributor license agreements. See the NOTICE file
04: * distributed with this work for additional information
05: * regarding copyright ownership. The ASF licenses this file
06: * to you under the Apache License, Version 2.0 (the
07: * "License"); you may not use this file except in compliance
08: * with the License. You may obtain a copy of the License at
09: *
10: * http://www.apache.org/licenses/LICENSE-2.0
11: *
12: * Unless required by applicable law or agreed to in writing,
13: * software distributed under the License is distributed on an
14: * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15: * KIND, either express or implied. See the License for the
16: * specific language governing permissions and limitations
17: * under the License.
18: *
19: */
20: package org.apache.mina.common;
21:
22: import java.nio.ByteBuffer;
23:
24: /**
25: * Allocates {@link IoBuffer}s and manages them. Please implement this
26: * interface if you need more advanced memory management scheme.
27: *
28: * @author The Apache MINA Project (dev@mina.apache.org)
29: * @version $Rev: 593795 $, $Date: 2007-11-10 10:21:20 -0700 (Sat, 10 Nov 2007) $
30: */
31: public interface IoBufferAllocator {
32: /**
33: * Returns the buffer which is capable of the specified size.
34: *
35: * @param capacity the capacity of the buffer
36: * @param direct <tt>true</tt> to get a direct buffer,
37: * <tt>false</tt> to get a heap buffer.
38: */
39: IoBuffer allocate(int capacity, boolean direct);
40:
41: /**
42: * Returns the NIO buffer which is capable of the specified size.
43: *
44: * @param capacity the capacity of the buffer
45: * @param direct <tt>true</tt> to get a direct buffer,
46: * <tt>false</tt> to get a heap buffer.
47: */
48: ByteBuffer allocateNioBuffer(int capacity, boolean direct);
49:
50: /**
51: * Wraps the specified NIO {@link ByteBuffer} into MINA buffer.
52: */
53: IoBuffer wrap(ByteBuffer nioBuffer);
54:
55: /**
56: * Dispose of this allocator.
57: */
58: void dispose();
59: }
|