1 | /** |
---|
2 | * Licensed to the Apache Software Foundation (ASF) under one |
---|
3 | * or more contributor license agreements. See the NOTICE file |
---|
4 | * distributed with this work for additional information |
---|
5 | * regarding copyright ownership. The ASF licenses this file |
---|
6 | * to you under the Apache License, Version 2.0 (the |
---|
7 | * "License"); you may not use this file except in compliance |
---|
8 | * with the License. You may obtain a copy of the License at |
---|
9 | * |
---|
10 | * http://www.apache.org/licenses/LICENSE-2.0 |
---|
11 | * |
---|
12 | * Unless required by applicable law or agreed to in writing, software |
---|
13 | * distributed under the License is distributed on an "AS IS" BASIS, |
---|
14 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
---|
15 | * See the License for the specific language governing permissions and |
---|
16 | * limitations under the License. |
---|
17 | */ |
---|
18 | package org.apache.hadoop.mapred; |
---|
19 | |
---|
20 | import java.io.InputStream; |
---|
21 | |
---|
22 | /** |
---|
23 | * <code>RamManager</code> manages a memory pool of a configured limit. |
---|
24 | */ |
---|
25 | interface RamManager { |
---|
26 | /** |
---|
27 | * Reserve memory for data coming through the given input-stream. |
---|
28 | * |
---|
29 | * @param requestedSize size of memory requested |
---|
30 | * @param in input stream |
---|
31 | * @throws InterruptedException |
---|
32 | * @return <code>true</code> if memory was allocated immediately, |
---|
33 | * else <code>false</code> |
---|
34 | */ |
---|
35 | boolean reserve(int requestedSize, InputStream in) |
---|
36 | throws InterruptedException; |
---|
37 | |
---|
38 | /** |
---|
39 | * Return memory to the pool. |
---|
40 | * |
---|
41 | * @param requestedSize size of memory returned to the pool |
---|
42 | */ |
---|
43 | void unreserve(int requestedSize); |
---|
44 | } |
---|