opensim/OpenSim/Framework/IAssetCache.cs

/*
 * Copyright (c) Contributors, http://opensimulator.org/
 * See CONTRIBUTORS.TXT for a full list of copyright holders.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the OpenSim Project nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

using OpenMetaverse;
using OpenMetaverse.Packets;

namespace OpenSim.Framework
{

    public delegate void AssetRequestCallback(UUID assetId, AssetBase asset);

    public interface IAssetCache : IAssetReceiver, IPlugin
    {

        IAssetServer AssetServer { get; }

        void ShowState();
        void Clear();
        bool TryGetCachedAsset(UUID assetID, out AssetBase asset);
        void GetAsset(UUID assetID, AssetRequestCallback callback, bool isTexture);
        AssetBase GetAsset(UUID assetID, bool isTexture);
        void AddAsset(AssetBase asset);
        void ExpireAsset(UUID assetID);
        void AddAssetRequest(IClientAPI userInfo, TransferRequestPacket transferRequest);

        void Initialise(ConfigSettings cs, IAssetServer server);

    }

    public class AssetCachePluginInitialiser : PluginInitialiserBase
    {
        private ConfigSettings config;
        private IAssetServer   server;

        public AssetCachePluginInitialiser (ConfigSettings p_sv, IAssetServer p_as)
        {
            config = p_sv;
            server = p_as;
        }
        public override void Initialise (IPlugin plugin)
        {
            IAssetCache p = plugin as IAssetCache;
            p.Initialise (config, server);
        }
    }

}