001/** 002 * 003 * Licensed to the Apache Software Foundation (ASF) under one 004 * or more contributor license agreements. See the NOTICE file 005 * distributed with this work for additional information 006 * regarding copyright ownership. The ASF licenses this file 007 * to you under the Apache License, Version 2.0 (the 008 * "License"); you may not use this file except in compliance 009 * with the License. You may obtain a copy of the License at 010 * 011 * http://www.apache.org/licenses/LICENSE-2.0 012 * 013 * Unless required by applicable law or agreed to in writing, software 014 * distributed under the License is distributed on an "AS IS" BASIS, 015 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 016 * See the License for the specific language governing permissions and 017 * limitations under the License. 018 */ 019 020package org.apache.hadoop.hbase.regionserver; 021 022import java.util.List; 023 024import org.apache.yetus.audience.InterfaceAudience; 025 026/** 027 * Request a flush. 028 */ 029@InterfaceAudience.Private 030public interface FlushRequester { 031 /** 032 * Tell the listener the cache needs to be flushed. 033 * 034 * @param region the Region requesting the cache flush 035 * @return true if our region is added into the queue, false otherwise 036 */ 037 boolean requestFlush(HRegion region, FlushLifeCycleTracker tracker); 038 039 /** 040 * Tell the listener the cache needs to be flushed. 041 * 042 * @param region the Region requesting the cache flush 043 * @param families stores of region to flush, if null then use flush policy 044 * @return true if our region is added into the queue, false otherwise 045 */ 046 boolean requestFlush(HRegion region, List<byte[]> families, 047 FlushLifeCycleTracker tracker); 048 049 /** 050 * Tell the listener the cache needs to be flushed after a delay 051 * 052 * @param region the Region requesting the cache flush 053 * @param delay after how much time should the flush happen 054 * @return true if our region is added into the queue, false otherwise 055 */ 056 boolean requestDelayedFlush(HRegion region, long delay); 057 058 /** 059 * Register a FlushRequestListener 060 * 061 * @param listener 062 */ 063 void registerFlushRequestListener(final FlushRequestListener listener); 064 065 /** 066 * Unregister the given FlushRequestListener 067 * 068 * @param listener 069 * @return true when passed listener is unregistered successfully. 070 */ 071 public boolean unregisterFlushRequestListener(final FlushRequestListener listener); 072 073 /** 074 * Sets the global memstore limit to a new size. 075 * 076 * @param globalMemStoreSize 077 */ 078 public void setGlobalMemStoreLimit(long globalMemStoreSize); 079}