org.ehcache.impl.internal.loaderwriter.writebehind.WriteBehind Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of ehcache-impl Show documentation

The implementation module of Ehcache 3

There is a newer version: 3.10.8

/*
 * Copyright Terracotta, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.ehcache.impl.internal.loaderwriter.writebehind;


import org.ehcache.spi.loaderwriter.CacheLoaderWriter;

/**
 * @author Geert Bevin
 * @author Chris Dennis
 *
 */
public interface WriteBehind extends CacheLoaderWriter {

  /**
   * Start the write behind queue
   *
   */
  void start();

  /**
   * Stop the coordinator and all the internal data structures.
   * 
   * This stops as quickly as possible without losing any previously added items. However, no guarantees are made
   * towards the processing of these items. It's highly likely that items are still inside the internal data structures
   * and not processed.
   */
  void stop();

  /**
   * Gets the best estimate for items in the queue still awaiting processing.
   *
   * @return the amount of elements still awaiting processing.
   */
  long getQueueSize();

}