IAssetCache.cs 2.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071
  1. /*
  2. * Copyright (c) Contributors, http://opensimulator.org/
  3. * See CONTRIBUTORS.TXT for a full list of copyright holders.
  4. *
  5. * Redistribution and use in source and binary forms, with or without
  6. * modification, are permitted provided that the following conditions are met:
  7. * * Redistributions of source code must retain the above copyright
  8. * notice, this list of conditions and the following disclaimer.
  9. * * Redistributions in binary form must reproduce the above copyright
  10. * notice, this list of conditions and the following disclaimer in the
  11. * documentation and/or other materials provided with the distribution.
  12. * * Neither the name of the OpenSimulator Project nor the
  13. * names of its contributors may be used to endorse or promote products
  14. * derived from this software without specific prior written permission.
  15. *
  16. * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
  17. * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  18. * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  19. * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
  20. * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  21. * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  22. * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  23. * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24. * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  25. * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26. */
  27. using OpenSim.Framework;
  28. namespace OpenSim.Framework
  29. {
  30. public interface IAssetCache
  31. {
  32. /// <summary>
  33. /// Cache the specified asset.
  34. /// </summary>
  35. /// <param name='asset'></param>
  36. void Cache(AssetBase asset, bool replace = false);
  37. /// <summary>
  38. /// Cache that the specified asset wasn't found.
  39. /// </summary>
  40. /// <param name='id'></param>
  41. /// <summary>
  42. void CacheNegative(string id);
  43. /// Get an asset by its id.
  44. /// </summary>
  45. /// <param name='id'></param>
  46. /// <param name='asset'>Will be set to null if no asset was found</param>
  47. /// <returns>False if the asset has been negative-cached</returns>
  48. bool Get(string id, out AssetBase asset);
  49. /// <summary>
  50. /// Check whether an asset with the specified id exists in the cache.
  51. /// </summary>
  52. /// <param name='id'></param>
  53. bool Check(string id);
  54. /// <summary>
  55. /// Expire an asset from the cache.
  56. /// </summary>
  57. /// <param name='id'></param>
  58. void Expire(string id);
  59. /// <summary>
  60. /// Clear the cache.
  61. /// </summary>
  62. void Clear();
  63. }
  64. }