com.microsoft.reef.io.network.Cache Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of reef-io Show documentation

There is a newer version: 0.9

/**
 * Copyright (C) 2013 Microsoft Corporation
 *
 * 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 com.microsoft.reef.io.network;

import com.microsoft.reef.exception.evaluator.NetworkException;

import java.util.concurrent.Callable;
import java.util.concurrent.ExecutionException;

/**
 * Cache for network and naming services
 */
public interface Cache {
  /**
   *  Constructs with timeout
   *  key is evicted when it's not used for timeout milli-seconds
   */
  
  /**
   * Returns a value for the key if cached; otherwise creates, caches and returns
   * When it creates a value for a key, only one callable for the key is executed
   * 
   * @param key a key
   * @param callable a value fetcher
   * @return a value
   * @throws NetworkException
   */
  public V get(K key, Callable valueFetcher) throws ExecutionException;
 
  /**
   * Invalidates a key from the cache
   * @param key a key
   */
  public void invalidate(K key);
  
}