MonoRail/Castle.MonoRail.Framework/Services/ICacheProvider.cs

   1 // Copyright 2004-2008 Castle Project - http://www.castleproject.org/
   2 //
   3 // Licensed under the Apache License, Version 2.0 (the "License");
   4 // you may not use this file except in compliance with the License.
   5 // You may obtain a copy of the License at
   6 //
   7 //     http://www.apache.org/licenses/LICENSE-2.0
   8 //
   9 // Unless required by applicable law or agreed to in writing, software
  10 // distributed under the License is distributed on an "AS IS" BASIS,
  11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 // See the License for the specific language governing permissions and
  13 // limitations under the License.
  14
  15 namespace Castle.MonoRail.Framework
  16 {
  17         using System;
  18         using Castle.MonoRail.Framework.Providers;
  19
  20         /// <summary>
  21         /// Depicts the contract for cache provider. Was
  22         /// created to be used with providers like memcached.
  23         /// </summary>
  24         public interface ICacheProvider : IProvider
  25         {
  26                 /// <summary>
  27                 /// Determines whether the specified key is on the cache.
  28                 /// </summary>
  29                 /// <param name="key">The key.</param>
  30                 /// <returns>
  31                 ///     <c>true</c> if the cache has the key; otherwise, <c>false</c>.
  32                 /// </returns>
  33                 bool HasKey(String key);
  34
  35                 /// <summary>
  36                 /// Gets the cache item by the specified key.
  37                 /// </summary>
  38                 /// <param name="key">The key.</param>
  39                 /// <returns></returns>
  40                 object Get(String key);
  41
  42                 /// <summary>
  43                 /// Stores the cache item by the specified key.
  44                 /// </summary>
  45                 /// <param name="key">The key.</param>
  46                 /// <param name="data">The data.</param>
  47                 void Store(String key, object data);
  48
  49                 /// <summary>
  50                 /// Deletes the cache item by the specified key.
  51                 /// </summary>
  52                 /// <param name="key">The key.</param>
  53                 void Delete(String key);
  54         }
  55 }