1 /**
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements. See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership. The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License. You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 */
19
20 package org.apache.hadoop.hbase.regionserver;
21
22 import org.apache.hadoop.hbase.classification.InterfaceAudience;
23
24 /**
25 * Request a flush.
26 */
27 @InterfaceAudience.Private
28 public interface FlushRequester {
29 /**
30 * Tell the listener the cache needs to be flushed.
31 *
32 * @param region the Region requesting the cache flush
33 * @param forceFlushAllStores whether we want to flush all stores. e.g., when request from log
34 * rolling.
35 * @return true if our region is added into the queue, false otherwise
36 */
37 boolean requestFlush(Region region, boolean forceFlushAllStores);
38
39 /**
40 * Tell the listener the cache needs to be flushed after a delay
41 *
42 * @param region the Region requesting the cache flush
43 * @param delay after how much time should the flush happen
44 * @param forceFlushAllStores whether we want to flush all stores. e.g., when request from log
45 * rolling.
46 * @return true if our region is added into the queue, false otherwise
47 */
48 boolean requestDelayedFlush(Region region, long delay, boolean forceFlushAllStores);
49
50 /**
51 * Register a FlushRequestListener
52 *
53 * @param listener
54 */
55 void registerFlushRequestListener(final FlushRequestListener listener);
56
57 /**
58 * Unregister the given FlushRequestListener
59 *
60 * @param listener
61 * @return true when passed listener is unregistered successfully.
62 */
63 public boolean unregisterFlushRequestListener(final FlushRequestListener listener);
64
65 /**
66 * Sets the global memstore limit to a new size.
67 *
68 * @param globalMemStoreSize
69 */
70 public void setGlobalMemstoreLimit(long globalMemStoreSize);
71 }