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 org.apache.yetus.audience.InterfaceAudience;
023
024/**
025 * Request a flush.
026 */
027@InterfaceAudience.Private
028public interface FlushRequester {
029  /**
030   * Tell the listener the cache needs to be flushed.
031   *
032   * @param region the Region requesting the cache flush
033   * @param forceFlushAllStores whether we want to flush all stores. e.g., when request from log
034   *          rolling.
035   * @return true if our region is added into the queue, false otherwise
036   */
037  boolean requestFlush(HRegion region, boolean forceFlushAllStores, FlushLifeCycleTracker tracker);
038
039  /**
040   * Tell the listener the cache needs to be flushed after a delay
041   *
042   * @param region the Region requesting the cache flush
043   * @param delay after how much time should the flush happen
044   * @param forceFlushAllStores whether we want to flush all stores. e.g., when request from log
045   *          rolling.
046   * @return true if our region is added into the queue, false otherwise
047   */
048  boolean requestDelayedFlush(HRegion region, long delay, boolean forceFlushAllStores);
049
050  /**
051   * Register a FlushRequestListener
052   *
053   * @param listener
054   */
055  void registerFlushRequestListener(final FlushRequestListener listener);
056
057  /**
058   * Unregister the given FlushRequestListener
059   *
060   * @param listener
061   * @return true when passed listener is unregistered successfully.
062   */
063  public boolean unregisterFlushRequestListener(final FlushRequestListener listener);
064
065  /**
066   * Sets the global memstore limit to a new size.
067   *
068   * @param globalMemStoreSize
069   */
070  public void setGlobalMemStoreLimit(long globalMemStoreSize);
071}