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 */
36 void requestFlush(Region region, boolean forceFlushAllStores);
37
38 /**
39 * Tell the listener the cache needs to be flushed after a delay
40 *
41 * @param region the Region requesting the cache flush
42 * @param delay after how much time should the flush happen
43 * @param forceFlushAllStores whether we want to flush all stores. e.g., when request from log
44 * rolling.
45 */
46 void requestDelayedFlush(Region region, long delay, boolean forceFlushAllStores);
47
48 /**
49 * Register a FlushRequestListener
50 *
51 * @param listener
52 */
53 void registerFlushRequestListener(final FlushRequestListener listener);
54
55 /**
56 * Unregister the given FlushRequestListener
57 *
58 * @param listener
59 * @return true when passed listener is unregistered successfully.
60 */
61 public boolean unregisterFlushRequestListener(final FlushRequestListener listener);
62
63 /**
64 * Sets the global memstore limit to a new size.
65 *
66 * @param globalMemStoreSize
67 */
68 public void setGlobalMemstoreLimit(long globalMemStoreSize);
69 }