opensim/OpenSim/Region/Framework/Interfaces/ITextureSender.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 OpenSimulator 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.
 */

namespace OpenSim.Region.Framework.Interfaces
{
    /// <summary>
    /// Interface for an object which can send texture information to a client
    /// </summary>
    public interface ITextureSender
    {
        /// <summary>
        /// Are we in the process of sending the texture?
        /// </summary>
        bool Sending { get; set; }

        /// <summary>
        /// Has the texture send been cancelled?
        /// </summary>
        bool Cancel { get; set; }

        /// <summary>
        /// Update the non data properties of a texture request
        /// </summary>
        /// <param name="discardLevel"></param>
        /// <param name="packetNumber"></param>
        void UpdateRequest(int discardLevel, uint packetNumber);

        /// <summary>
        /// Send a texture packet to the client.
        /// </summary>
        /// <returns>True if the last packet has been sent, false otherwise.</returns>
        bool SendTexturePacket();
    }
}