6 files changed, 406 insertions, 284 deletions

diff --git a/OpenSim/Region/ClientStack/LindenUDP/J2KImage.cs b/OpenSim/Region/ClientStack/LindenUDP/J2KImage.cs
index e9e2dca..9dd6663 100644
--- a/OpenSim/Region/ClientStack/LindenUDP/J2KImage.cs
+++ b/OpenSim/Region/ClientStack/LindenUDP/J2KImage.cs
@@ -202,6 +202,9 @@ namespace OpenSim.Region.ClientStack.LindenUDP
                             m_stopPacket = TexturePacketCount();
                         }
 
+                        //Give them at least two packets, to play nice with some broken viewers (SL also behaves this way)
+                        if (m_stopPacket == 1 && Layers[0].End > FIRST_PACKET_SIZE) m_stopPacket++;
+
                         m_currentPacket = StartPacket;
                     }
                 }
diff --git a/OpenSim/Region/ClientStack/LindenUDP/LLClientView.cs b/OpenSim/Region/ClientStack/LindenUDP/LLClientView.cs
index 0d142f4..105501f 100644
--- a/OpenSim/Region/ClientStack/LindenUDP/LLClientView.cs
+++ b/OpenSim/Region/ClientStack/LindenUDP/LLClientView.cs
@@ -155,6 +155,7 @@ namespace OpenSim.Region.ClientStack.LindenUDP
         public event RequestTaskInventory OnRequestTaskInventory;
         public event UpdateInventoryItem OnUpdateInventoryItem;
         public event CopyInventoryItem OnCopyInventoryItem;
+        public event MoveItemsAndLeaveCopy OnMoveItemsAndLeaveCopy;
         public event MoveInventoryItem OnMoveInventoryItem;
         public event RemoveInventoryItem OnRemoveInventoryItem;
         public event RemoveInventoryFolder OnRemoveInventoryFolder;
@@ -336,11 +337,13 @@ namespace OpenSim.Region.ClientStack.LindenUDP
 //        protected HashSet<uint> m_attachmentsSent;        
         
         private int m_moneyBalance;
+        private bool m_deliverPackets = true;
         private int m_animationSequenceNumber = 1;
         private bool m_SendLogoutPacketWhenClosing = true;
         private AgentUpdateArgs lastarg;
         private bool m_IsActive = true;
         private bool m_IsLoggingOut = false;
+        private bool m_IsPresenceReady = false;
 
         protected Dictionary<PacketType, PacketProcessor> m_packetHandlers = new Dictionary<PacketType, PacketProcessor>();
         protected Dictionary<string, GenericMessage> m_genericPacketHandlers = new Dictionary<string, GenericMessage>(); //PauPaw:Local Generic Message handlers
@@ -363,6 +366,7 @@ namespace OpenSim.Region.ClientStack.LindenUDP
 
         private Timer m_propertiesPacketTimer;
         private List<ObjectPropertiesPacket.ObjectDataBlock> m_propertiesBlocks = new List<ObjectPropertiesPacket.ObjectDataBlock>();
+        private List<Packet> m_pendingPackets;
 
         #endregion Class Members
 
@@ -378,6 +382,14 @@ namespace OpenSim.Region.ClientStack.LindenUDP
             get { return m_startpos; }
             set { m_startpos = value; }
         }
+        public bool DeliverPackets
+        {
+            get { return m_deliverPackets; }
+            set {
+                m_deliverPackets = value;
+                m_udpClient.m_deliverPackets = value;
+            }
+        }
         public UUID AgentId { get { return m_agentId; } }
         public UUID ActiveGroupId { get { return m_activeGroupID; } }
         public string ActiveGroupName { get { return m_activeGroupName; } }
@@ -407,6 +419,7 @@ namespace OpenSim.Region.ClientStack.LindenUDP
             get { return m_IsActive; }
             set { m_IsActive = value; }
         }
+
         public bool IsLoggingOut
         {
             get { return m_IsLoggingOut; }
@@ -476,18 +489,30 @@ namespace OpenSim.Region.ClientStack.LindenUDP
 
         #region Client Methods
 
+
         /// <summary>
         /// Shut down the client view
         /// </summary>
         public void Close()
         {
+            Close(true);
+        }
+
+        /// <summary>
+        /// Shut down the client view
+        /// </summary>
+        public void Close(bool sendStop)
+        {
             m_log.DebugFormat(
                 "[CLIENT]: Close has been called for {0} attached to scene {1}",
                 Name, m_scene.RegionInfo.RegionName);
 
-            // Send the STOP packet
-            DisableSimulatorPacket disable = (DisableSimulatorPacket)PacketPool.Instance.GetPacket(PacketType.DisableSimulator);
-            OutPacket(disable, ThrottleOutPacketType.Unknown);
+            if (sendStop)
+            {
+                // Send the STOP packet
+                DisableSimulatorPacket disable = (DisableSimulatorPacket)PacketPool.Instance.GetPacket(PacketType.DisableSimulator);
+                OutPacket(disable, ThrottleOutPacketType.Unknown);
+            }
 
             IsActive = false;
 
@@ -767,7 +792,7 @@ namespace OpenSim.Region.ClientStack.LindenUDP
             reply.ChatData.OwnerID = fromAgentID;
             reply.ChatData.SourceID = fromAgentID;
 
-            OutPacket(reply, ThrottleOutPacketType.Task);
+            OutPacket(reply, ThrottleOutPacketType.Unknown);
         }
 
         /// <summary>
@@ -1053,6 +1078,10 @@ namespace OpenSim.Region.ClientStack.LindenUDP
         public virtual void SendLayerData(float[] map)
         {
             Util.FireAndForget(DoSendLayerData, map);
+
+            // Send it sync, and async. It's not that much data
+            // and it improves user experience just so much!
+            DoSendLayerData(map);
         }
 
         /// <summary>
@@ -1065,16 +1094,13 @@ namespace OpenSim.Region.ClientStack.LindenUDP
 
             try
             {
-                //for (int y = 0; y < 16; y++)
-                //{
-                //    for (int x = 0; x < 16; x++)
-                //    {
-                //        SendLayerData(x, y, map);
-                //    }
-                //}
-
-                // Send LayerData in a spiral pattern. Fun!
-                SendLayerTopRight(map, 0, 0, 15, 15);
+                for (int y = 0; y < 16; y++)
+                {
+                    for (int x = 0; x < 16; x+=4)
+                    {
+                        SendLayerPacket(x, y, map);
+                    }
+                }
             }
             catch (Exception e)
             {
@@ -1082,51 +1108,35 @@ namespace OpenSim.Region.ClientStack.LindenUDP
             }
         }
 
-        private void SendLayerTopRight(float[] map, int x1, int y1, int x2, int y2)
-        {
-            // Row
-            for (int i = x1; i <= x2; i++)
-                SendLayerData(i, y1, map);
-
-            // Column
-            for (int j = y1 + 1; j <= y2; j++)
-                SendLayerData(x2, j, map);
-
-            if (x2 - x1 > 0)
-                SendLayerBottomLeft(map, x1, y1 + 1, x2 - 1, y2);
-        }
-
-        void SendLayerBottomLeft(float[] map, int x1, int y1, int x2, int y2)
-        {
-            // Row in reverse
-            for (int i = x2; i >= x1; i--)
-                SendLayerData(i, y2, map);
-
-            // Column in reverse
-            for (int j = y2 - 1; j >= y1; j--)
-                SendLayerData(x1, j, map);
-
-            if (x2 - x1 > 0)
-                SendLayerTopRight(map, x1 + 1, y1, x2, y2 - 1);
-        }
-
         /// <summary>
         /// Sends a set of four patches (x, x+1, ..., x+3) to the client
         /// </summary>
         /// <param name="map">heightmap</param>
         /// <param name="px">X coordinate for patches 0..12</param>
         /// <param name="py">Y coordinate for patches 0..15</param>
-        // private void SendLayerPacket(float[] map, int y, int x)
-        // {
-        //     int[] patches = new int[4];
-        //     patches[0] = x + 0 + y * 16;
-        //     patches[1] = x + 1 + y * 16;
-        //     patches[2] = x + 2 + y * 16;
-        //     patches[3] = x + 3 + y * 16;
-
-        //     Packet layerpack = LLClientView.TerrainManager.CreateLandPacket(map, patches);
-        //     OutPacket(layerpack, ThrottleOutPacketType.Land);
-        // }
+        private void SendLayerPacket(int x, int y, float[] map)
+        {
+            int[] patches = new int[4];
+            patches[0] = x + 0 + y * 16;
+            patches[1] = x + 1 + y * 16;
+            patches[2] = x + 2 + y * 16;
+            patches[3] = x + 3 + y * 16;
+
+            float[] heightmap = (map.Length == 65536) ?
+                map :
+                LLHeightFieldMoronize(map);
+
+            try
+            {
+                Packet layerpack = TerrainCompressor.CreateLandPacket(heightmap, patches);
+                OutPacket(layerpack, ThrottleOutPacketType.Land);
+            }
+            catch
+            {
+                for (int px = x ; px < x + 4 ; px++)
+                    SendLayerData(px, y, map);
+            }
+        }
 
         /// <summary>
         /// Sends a specified patch to a client
@@ -1146,7 +1156,7 @@ namespace OpenSim.Region.ClientStack.LindenUDP
                 LayerDataPacket layerpack = TerrainCompressor.CreateLandPacket(heightmap, patches);
                 layerpack.Header.Reliable = true;
 
-                OutPacket(layerpack, ThrottleOutPacketType.Land);
+                OutPacket(layerpack, ThrottleOutPacketType.Task);
             }
             catch (Exception e)
             {
@@ -2229,6 +2239,15 @@ namespace OpenSim.Region.ClientStack.LindenUDP
             OutPacket(sound, ThrottleOutPacketType.Task);
         }
 
+        public void SendTransferAbort(TransferRequestPacket transferRequest)
+        {
+            TransferAbortPacket abort = (TransferAbortPacket)PacketPool.Instance.GetPacket(PacketType.TransferAbort);
+            abort.TransferInfo.TransferID = transferRequest.TransferInfo.TransferID;
+            abort.TransferInfo.ChannelType = transferRequest.TransferInfo.ChannelType;
+            m_log.Debug("[Assets] Aborting transfer; asset request failed");
+            OutPacket(abort, ThrottleOutPacketType.Task);
+        }
+
         public void SendTriggeredSound(UUID soundID, UUID ownerID, UUID objectID, UUID parentID, ulong handle, Vector3 position, float gain)
         {
             SoundTriggerPacket sound = (SoundTriggerPacket)PacketPool.Instance.GetPacket(PacketType.SoundTrigger);
@@ -3516,6 +3535,15 @@ namespace OpenSim.Region.ClientStack.LindenUDP
         /// </summary>
         public void SendPrimUpdate(ISceneEntity entity, PrimUpdateFlags updateFlags)
         {
+            if (entity is SceneObjectPart)
+            {
+                SceneObjectPart e = (SceneObjectPart)entity;
+                SceneObjectGroup g = e.ParentGroup;
+                if (g.RootPart.Shape.State > 30) // HUD
+                    if (g.OwnerID != AgentId)
+                        return; // Don't send updates for other people's HUDs
+            }
+
             double priority = m_prioritizer.GetUpdatePriority(this, entity);
 
             lock (m_entityUpdates.SyncRoot)
@@ -3536,23 +3564,13 @@ namespace OpenSim.Region.ClientStack.LindenUDP
                 EntityUpdate update;
                 while (updatesThisCall < maxUpdates && m_entityUpdates.TryDequeue(out update))
                 {
-                    // Please do not remove this unless you can demonstrate on the OpenSim mailing list that a client 
-                    // will never receive an update after a prim kill.  Even then, keeping the kill record may be a good
-                    // safety measure.
-                    //
-                    // Receiving updates after kills results in undeleteable prims that persist until relog and 
-                    // currently occurs because prims can be deleted before all queued updates are sent.
-                    if (m_killRecord.Contains(update.Entity.LocalId))
-                    {
-//                        m_log.WarnFormat(
-//                            "[CLIENT]: Preventing full update for prim with local id {0} after client for user {1} told it was deleted", 
-//                            update.Entity.LocalId, Name);                        
-                        continue;
-                    }
-                    
+                    // If we have sent a kill packet for this object
+                    // drop any updates on the floor
                     if (update.Entity is SceneObjectPart)
                     {
                         SceneObjectPart part = (SceneObjectPart)update.Entity;
+                        if (m_killRecord.Contains(part.ParentGroup.RootPart.LocalId))
+                            continue;
 
                         if (part.ParentGroup.IsAttachment && m_disableFacelights)
                         {
@@ -3986,6 +4004,9 @@ namespace OpenSim.Region.ClientStack.LindenUDP
             {
                 m_propertiesPacketTimer.Stop();
 
+                if (m_propertiesBlocks.Count == 0)
+                    return;
+
                 proper.ObjectData = new ObjectPropertiesPacket.ObjectDataBlock[m_propertiesBlocks.Count];
 
                 int index = 0;
@@ -4892,6 +4913,7 @@ namespace OpenSim.Region.ClientStack.LindenUDP
             AddLocalPacketHandler(PacketType.TransferAbort, HandleTransferAbort, false);
             AddLocalPacketHandler(PacketType.MuteListRequest, HandleMuteListRequest, false);
             AddLocalPacketHandler(PacketType.UseCircuitCode, HandleUseCircuitCode);
+            AddLocalPacketHandler(PacketType.CreateNewOutfitAttachments, HandleCreateNewOutfitAttachments);
             AddLocalPacketHandler(PacketType.AgentHeightWidth, HandleAgentHeightWidth, false);
             AddLocalPacketHandler(PacketType.InventoryDescendents, HandleInventoryDescendents);
             AddLocalPacketHandler(PacketType.DirPlacesQuery, HandleDirPlacesQuery);
@@ -4991,6 +5013,7 @@ namespace OpenSim.Region.ClientStack.LindenUDP
                         (x.CameraLeftAxis != lastarg.CameraLeftAxis) ||
                         (x.CameraUpAxis != lastarg.CameraUpAxis) ||
                         (x.ControlFlags != lastarg.ControlFlags) ||
+                        (x.ControlFlags != 0) ||
                         (x.Far != lastarg.Far) ||
                         (x.Flags != lastarg.Flags) ||
                         (x.State != lastarg.State) ||
@@ -5362,7 +5385,7 @@ namespace OpenSim.Region.ClientStack.LindenUDP
                 args.Channel = ch;
                 args.From = String.Empty;
                 args.Message = Utils.BytesToString(msg);
-                args.Type = ChatTypeEnum.Shout;
+                args.Type = ChatTypeEnum.Region; //Behaviour in SL is that the response can be heard from any distance
                 args.Position = new Vector3();
                 args.Scene = Scene;
                 args.Sender = this;
@@ -9400,6 +9423,37 @@ namespace OpenSim.Region.ClientStack.LindenUDP
         {
             return true;
         }
+        
+        private bool HandleCreateNewOutfitAttachments(IClientAPI sender, Packet Pack)
+        {
+            CreateNewOutfitAttachmentsPacket packet = (CreateNewOutfitAttachmentsPacket)Pack;
+
+            #region Packet Session and User Check
+            if (m_checkPackets)
+            {
+                if (packet.AgentData.SessionID != SessionId ||
+                    packet.AgentData.AgentID != AgentId)
+                    return true;
+            }
+            #endregion
+            MoveItemsAndLeaveCopy handlerMoveItemsAndLeaveCopy = null;
+            List<InventoryItemBase> items = new List<InventoryItemBase>();
+            foreach (CreateNewOutfitAttachmentsPacket.ObjectDataBlock n in packet.ObjectData)
+            {
+                InventoryItemBase b = new InventoryItemBase();
+                b.ID = n.OldItemID;
+                b.Folder = n.OldFolderID;
+                items.Add(b);
+            }
+
+            handlerMoveItemsAndLeaveCopy = OnMoveItemsAndLeaveCopy;
+            if (handlerMoveItemsAndLeaveCopy != null)
+            {
+                handlerMoveItemsAndLeaveCopy(this, items, packet.HeaderData.NewFolderID);
+            }
+
+            return true;
+        }
 
         private bool HandleAgentHeightWidth(IClientAPI sender, Packet Pack)
         {
@@ -11243,18 +11297,44 @@ namespace OpenSim.Region.ClientStack.LindenUDP
         }
 
         /// <summary>
+        /// This processes packets which have accumulated while the presence was still in the process of initialising.
+        /// </summary>
+        public void ProcessPendingPackets()
+        {
+            m_IsPresenceReady = true;
+            if (m_pendingPackets == null)
+                return; 
+            foreach (Packet p in m_pendingPackets)
+            {
+                ProcessInPacket(p);
+            }
+            m_pendingPackets.Clear();
+        }
+
+        /// <summary>
         /// Entryway from the client to the simulator.  All UDP packets from the client will end up here
         /// </summary>
         /// <param name="Pack">OpenMetaverse.packet</param>
         public void ProcessInPacket(Packet Pack)
         {
-            if (m_debugPacketLevel >= 255)
-                m_log.DebugFormat("[CLIENT]: Packet IN {0}", Pack.Type);
+            if (!m_IsPresenceReady)
+            {
+                if (m_pendingPackets == null)
+                {
+                    m_pendingPackets = new List<Packet>();
+                }
+                m_pendingPackets.Add(Pack);
+            }
+            else
+            {
+                if (m_debugPacketLevel >= 255)
+                    m_log.DebugFormat("[CLIENT]: Packet IN {0}", Pack.Type);
 
-            if (!ProcessPacketMethod(Pack))
-                m_log.Warn("[CLIENT]: unhandled packet " + Pack.Type);
+                if (!ProcessPacketMethod(Pack))
+                    m_log.Warn("[CLIENT]: unhandled packet " + Pack.Type);
 
-            PacketPool.Instance.ReturnPacket(Pack);
+                PacketPool.Instance.ReturnPacket(Pack);
+            }
         }
 
         private static PrimitiveBaseShape GetShapeFromAddPacket(ObjectAddPacket addPacket)
@@ -11491,7 +11571,10 @@ namespace OpenSim.Region.ClientStack.LindenUDP
 
 //            m_log.DebugFormat("[CLIENT]: {0} requesting asset {1}", Name, requestID);
 
+
+            //Note, the bool returned from the below function is useless since it is always false.
             m_assetService.Get(requestID.ToString(), transferRequest, AssetReceived);
+
         }
 
         /// <summary>
diff --git a/OpenSim/Region/ClientStack/LindenUDP/LLUDPClient.cs b/OpenSim/Region/ClientStack/LindenUDP/LLUDPClient.cs
index 6232c48..eebbfa5 100644
--- a/OpenSim/Region/ClientStack/LindenUDP/LLUDPClient.cs
+++ b/OpenSim/Region/ClientStack/LindenUDP/LLUDPClient.cs
@@ -149,6 +149,7 @@ namespace OpenSim.Region.ClientStack.LindenUDP
 
         private int m_defaultRTO = 3000;
         private int m_maxRTO = 60000;
+        public bool m_deliverPackets = true;
 
         /// <summary>
         /// Default constructor
@@ -389,6 +390,13 @@ namespace OpenSim.Region.ClientStack.LindenUDP
             if (category >= 0 && category < m_packetOutboxes.Length)
             {
                 OpenSim.Framework.LocklessQueue<OutgoingPacket> queue = m_packetOutboxes[category];
+
+                if (m_deliverPackets == false)
+                {
+                    queue.Enqueue(packet);
+                    return true;
+                }
+
                 TokenBucket bucket = m_throttleCategories[category];
 
                 if (bucket.RemoveTokens(packet.Buffer.DataLength))
@@ -419,6 +427,8 @@ namespace OpenSim.Region.ClientStack.LindenUDP
         /// <returns>True if any packets were sent, otherwise false</returns>
         public bool DequeueOutgoing()
         {
+            if (m_deliverPackets == false) return false;
+
             OutgoingPacket packet;
             OpenSim.Framework.LocklessQueue<OutgoingPacket> queue;
             TokenBucket bucket;
diff --git a/OpenSim/Region/ClientStack/LindenUDP/LLUDPServer.cs b/OpenSim/Region/ClientStack/LindenUDP/LLUDPServer.cs
index ca5a297..209e35c 100644
--- a/OpenSim/Region/ClientStack/LindenUDP/LLUDPServer.cs
+++ b/OpenSim/Region/ClientStack/LindenUDP/LLUDPServer.cs
@@ -904,7 +904,30 @@ namespace OpenSim.Region.ClientStack.LindenUDP
                 client.DisableFacelights = m_disableFacelights;
 
                 // Start the IClientAPI
-                client.Start();
+                // Spin it off so that it doesn't clog up the LLUDPServer
+                
+                //First, and very importantly:
+                //
+                //Set our DeliverPackets flag in the client to *false*
+                //this will prevent us from missing important messages
+                //before the modules are bound
+                client.DeliverPackets = false;
+                client.DisableFacelights = m_disableFacelights;
+                
+                Util.FireAndForget(
+                    delegate
+                    {
+                        try
+                        {
+                            client.Start();
+                        }
+                        finally
+                        {
+                            //Now, release the hounds. er, packets.
+                            client.DeliverPackets = true;
+                        }
+                    }
+                );
             }
             else
             {
@@ -920,7 +943,7 @@ namespace OpenSim.Region.ClientStack.LindenUDP
             if (m_scene.TryGetClient(udpClient.AgentID, out client))
             {
                 client.IsLoggingOut = true;
-                client.Close();
+                client.Close(false);
             }
         }
 
diff --git a/OpenSim/Region/ClientStack/LindenUDP/TokenBucket.cs b/OpenSim/Region/ClientStack/LindenUDP/TokenBucket.cs
index bdbd284..91e3d20 100644
--- a/OpenSim/Region/ClientStack/LindenUDP/TokenBucket.cs
+++ b/OpenSim/Region/ClientStack/LindenUDP/TokenBucket.cs
@@ -133,7 +133,7 @@ namespace OpenSim.Region.ClientStack.LindenUDP
             this.parent = parent;
             MaxBurst = maxBurst;
             DripRate = dripRate;
-            lastDrip = Environment.TickCount & Int32.MaxValue;
+            lastDrip = Environment.TickCount;
         }
 
         /// <summary>
@@ -144,40 +144,30 @@ namespace OpenSim.Region.ClientStack.LindenUDP
         /// the bucket, otherwise false</returns>
         public bool RemoveTokens(int amount)
         {
-            bool dummy;
-            return RemoveTokens(amount, out dummy);
-        }
-
-        /// <summary>
-        /// Remove a given number of tokens from the bucket
-        /// </summary>
-        /// <param name="amount">Number of tokens to remove from the bucket</param>
-        /// <param name="dripSucceeded">True if tokens were added to the bucket
-        /// during this call, otherwise false</param>
-        /// <returns>True if the requested number of tokens were removed from
-        /// the bucket, otherwise false</returns>
-        public bool RemoveTokens(int amount, out bool dripSucceeded)
-        {
             if (maxBurst == 0)
             {
-                dripSucceeded = true;
                 return true;
             }
 
-            dripSucceeded = Drip();
-
-            if (content - amount >= 0)
+            if (amount > maxBurst)
             {
-                if (parent != null && !parent.RemoveTokens(amount))
-                    return false;
+                throw new Exception("amount " + amount + " exceeds maxBurst " + maxBurst);
+            }
 
-                content -= amount;
-                return true;
+            Drip();
+
+            if (content < amount)
+            {
+                return false;
             }
-            else
+
+            if (parent != null && !parent.RemoveTokens(amount))
             {
                 return false;
             }
+
+            content -= amount;
+            return true;
         }
 
         /// <summary>
@@ -193,25 +183,23 @@ namespace OpenSim.Region.ClientStack.LindenUDP
                 content = maxBurst;
                 return true;
             }
-            else
-            {
-                int now = Environment.TickCount & Int32.MaxValue;
-                int deltaMS = now - lastDrip;
 
-                if (deltaMS <= 0)
-                {
-                    if (deltaMS < 0)
-                        lastDrip = now;
-                    return false;
-                }
+            int now = Environment.TickCount;
+            int deltaMS = now - lastDrip;
+            lastDrip = now;
 
-                int dripAmount = deltaMS * tokensPerMS;
-
-                content = Math.Min(content + dripAmount, maxBurst);
-                lastDrip = now;
+            if (deltaMS <= 0)
+            {
+                return false;
+            }
 
-                return true;
+            long dripAmount = (long)deltaMS * (long)tokensPerMS + (long)content;
+            if (dripAmount > maxBurst)
+            {
+                dripAmount = maxBurst;
             }
+            content = (int)dripAmount;
+            return true;
         }
     }
 }
diff --git a/OpenSim/Region/ClientStack/LindenUDP/UnackedPacketCollection.cs b/OpenSim/Region/ClientStack/LindenUDP/UnackedPacketCollection.cs
index e43f7cf..c120a12 100644
--- a/OpenSim/Region/ClientStack/LindenUDP/UnackedPacketCollection.cs
+++ b/OpenSim/Region/ClientStack/LindenUDP/UnackedPacketCollection.cs
@@ -1,169 +1,184 @@
-/*
- * 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.
- */
-
-using System;
-using System.Collections.Generic;
-using System.Net;
-using OpenMetaverse;
-
-namespace OpenSim.Region.ClientStack.LindenUDP
-{
-    /// <summary>
-    /// Special collection that is optimized for tracking unacknowledged packets
-    /// </summary>
-    public sealed class UnackedPacketCollection
-    {
-        /// <summary>
-        /// Holds information about a pending acknowledgement
-        /// </summary>
-        private struct PendingAck
-        {
-            /// <summary>Sequence number of the packet to remove</summary>
-            public uint SequenceNumber;
-            /// <summary>Environment.TickCount value when the remove was queued.
-            /// This is used to update round-trip times for packets</summary>
-            public int RemoveTime;
-            /// <summary>Whether or not this acknowledgement was attached to a
-            /// resent packet. If so, round-trip time will not be calculated</summary>
-            public bool FromResend;
-
-            public PendingAck(uint sequenceNumber, int currentTime, bool fromResend)
-            {
-                SequenceNumber = sequenceNumber;
-                RemoveTime = currentTime;
-                FromResend = fromResend;
-            }
-        }
-
-        /// <summary>Holds the actual unacked packet data, sorted by sequence number</summary>
-        private Dictionary<uint, OutgoingPacket> m_packets = new Dictionary<uint, OutgoingPacket>();
-        /// <summary>Holds packets that need to be added to the unacknowledged list</summary>
-        private LocklessQueue<OutgoingPacket> m_pendingAdds = new LocklessQueue<OutgoingPacket>();
-        /// <summary>Holds information about pending acknowledgements</summary>
-        private LocklessQueue<PendingAck> m_pendingRemoves = new LocklessQueue<PendingAck>();
-
-        /// <summary>
-        /// Add an unacked packet to the collection
-        /// </summary>
-        /// <param name="packet">Packet that is awaiting acknowledgement</param>
-        /// <returns>True if the packet was successfully added, false if the
-        /// packet already existed in the collection</returns>
-        /// <remarks>This does not immediately add the ACK to the collection,
-        /// it only queues it so it can be added in a thread-safe way later</remarks>
-        public void Add(OutgoingPacket packet)
-        {
-            m_pendingAdds.Enqueue(packet);
-        }
-
-        /// <summary>
-        /// Marks a packet as acknowledged
-        /// </summary>
-        /// <param name="sequenceNumber">Sequence number of the packet to
-        /// acknowledge</param>
-        /// <param name="currentTime">Current value of Environment.TickCount</param>
-        /// <remarks>This does not immediately acknowledge the packet, it only
-        /// queues the ack so it can be handled in a thread-safe way later</remarks>
-        public void Remove(uint sequenceNumber, int currentTime, bool fromResend)
-        {
-            m_pendingRemoves.Enqueue(new PendingAck(sequenceNumber, currentTime, fromResend));
-        }
-
-        /// <summary>
-        /// Returns a list of all of the packets with a TickCount older than
-        /// the specified timeout
-        /// </summary>
-        /// <param name="timeoutMS">Number of ticks (milliseconds) before a
-        /// packet is considered expired</param>
-        /// <returns>A list of all expired packets according to the given
-        /// expiration timeout</returns>
-        /// <remarks>This function is not thread safe, and cannot be called
-        /// multiple times concurrently</remarks>
-        public List<OutgoingPacket> GetExpiredPackets(int timeoutMS)
-        {
-            ProcessQueues();
-
-            List<OutgoingPacket> expiredPackets = null;
-
-            if (m_packets.Count > 0)
-            {
-                int now = Environment.TickCount & Int32.MaxValue;
-
-                foreach (OutgoingPacket packet in m_packets.Values)
-                {
-                    // TickCount of zero means a packet is in the resend queue 
-                    // but hasn't actually been sent over the wire yet
-                    if (packet.TickCount == 0)
-                        continue;
-
-                    if (now - packet.TickCount >= timeoutMS)
-                    {
-                        if (expiredPackets == null)
-                            expiredPackets = new List<OutgoingPacket>();
-
-                        // The TickCount will be set to the current time when the packet
-                        // is actually sent out again
-                        packet.TickCount = 0;
-
-                        expiredPackets.Add(packet);
-                    }
-                }
-            }
-
-            return expiredPackets;
-        }
-
-        private void ProcessQueues()
-        {
-            // Process all the pending adds
-            OutgoingPacket pendingAdd;
-            while (m_pendingAdds.Dequeue(out pendingAdd))
-                m_packets[pendingAdd.SequenceNumber] = pendingAdd;
-
-            // Process all the pending removes, including updating statistics and round-trip times
-            PendingAck pendingRemove;
-            OutgoingPacket ackedPacket;
-            while (m_pendingRemoves.Dequeue(out pendingRemove))
-            {
-                if (m_packets.TryGetValue(pendingRemove.SequenceNumber, out ackedPacket))
-                {
-                    m_packets.Remove(pendingRemove.SequenceNumber);
-
-                    // Update stats
-                    System.Threading.Interlocked.Add(ref ackedPacket.Client.UnackedBytes, -ackedPacket.Buffer.DataLength);
-
-                    if (!pendingRemove.FromResend)
-                    {
-                        // Calculate the round-trip time for this packet and its ACK
-                        int rtt = pendingRemove.RemoveTime - ackedPacket.TickCount;
-                        if (rtt > 0)
-                            ackedPacket.Client.UpdateRoundTrip(rtt);
-                    }
-                }
-            }
-        }
-    }
-}
+/*

+ * 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.

+ */

+

+using System;

+using System.Collections.Generic;

+using System.Net;

+using OpenMetaverse;

+

+namespace OpenSim.Region.ClientStack.LindenUDP

+{

+    /// <summary>

+    /// Special collection that is optimized for tracking unacknowledged packets

+    /// </summary>

+    public sealed class UnackedPacketCollection

+    {

+        /// <summary>

+        /// Holds information about a pending acknowledgement

+        /// </summary>

+        private struct PendingAck

+        {

+            /// <summary>Sequence number of the packet to remove</summary>

+            public uint SequenceNumber;

+            /// <summary>Environment.TickCount value when the remove was queued.

+            /// This is used to update round-trip times for packets</summary>

+            public int RemoveTime;

+            /// <summary>Whether or not this acknowledgement was attached to a

+            /// resent packet. If so, round-trip time will not be calculated</summary>

+            public bool FromResend;

+

+            public PendingAck(uint sequenceNumber, int currentTime, bool fromResend)

+            {

+                SequenceNumber = sequenceNumber;

+                RemoveTime = currentTime;

+                FromResend = fromResend;

+            }

+        }

+

+        /// <summary>Holds the actual unacked packet data, sorted by sequence number</summary>

+        private Dictionary<uint, OutgoingPacket> m_packets = new Dictionary<uint, OutgoingPacket>();

+        /// <summary>Holds packets that need to be added to the unacknowledged list</summary>

+        private LocklessQueue<OutgoingPacket> m_pendingAdds = new LocklessQueue<OutgoingPacket>();

+        /// <summary>Holds information about pending acknowledgements</summary>

+        private LocklessQueue<PendingAck> m_pendingRemoves = new LocklessQueue<PendingAck>();

+

+        /// <summary>

+        /// Add an unacked packet to the collection

+        /// </summary>

+        /// <param name="packet">Packet that is awaiting acknowledgement</param>

+        /// <returns>True if the packet was successfully added, false if the

+        /// packet already existed in the collection</returns>

+        /// <remarks>This does not immediately add the ACK to the collection,

+        /// it only queues it so it can be added in a thread-safe way later</remarks>

+        public void Add(OutgoingPacket packet)

+        {

+            m_pendingAdds.Enqueue(packet);

+        }

+

+        /// <summary>

+        /// Marks a packet as acknowledged

+        /// </summary>

+        /// <param name="sequenceNumber">Sequence number of the packet to

+        /// acknowledge</param>

+        /// <param name="currentTime">Current value of Environment.TickCount</param>

+        /// <remarks>This does not immediately acknowledge the packet, it only

+        /// queues the ack so it can be handled in a thread-safe way later</remarks>

+        public void Remove(uint sequenceNumber, int currentTime, bool fromResend)

+        {

+            m_pendingRemoves.Enqueue(new PendingAck(sequenceNumber, currentTime, fromResend));

+        }

+

+        /// <summary>

+        /// Returns a list of all of the packets with a TickCount older than

+        /// the specified timeout

+        /// </summary>

+        /// <param name="timeoutMS">Number of ticks (milliseconds) before a

+        /// packet is considered expired</param>

+        /// <returns>A list of all expired packets according to the given

+        /// expiration timeout</returns>

+        /// <remarks>This function is not thread safe, and cannot be called

+        /// multiple times concurrently</remarks>

+        public List<OutgoingPacket> GetExpiredPackets(int timeoutMS)

+        {

+            ProcessQueues();

+

+            List<OutgoingPacket> expiredPackets = null;

+

+            if (m_packets.Count > 0)

+            {

+                int now = Environment.TickCount & Int32.MaxValue;

+

+                foreach (OutgoingPacket packet in m_packets.Values)

+                {

+                    // TickCount of zero means a packet is in the resend queue 

+                    // but hasn't actually been sent over the wire yet

+                    if (packet.TickCount == 0)

+                        continue;

+

+                    if (now - packet.TickCount >= timeoutMS)

+                    {

+                        if (expiredPackets == null)

+                            expiredPackets = new List<OutgoingPacket>();

+

+                        // The TickCount will be set to the current time when the packet

+                        // is actually sent out again

+                        packet.TickCount = 0;

+

+                        expiredPackets.Add(packet);

+                    }

+                }

+            }

+

+            return expiredPackets;

+        }

+

+        private void ProcessQueues()

+        {

+            // Process all the pending adds

+

+            OutgoingPacket pendingAdd;

+            if (m_pendingAdds != null)

+            {

+                while (m_pendingAdds.Dequeue(out pendingAdd))

+                {

+                    if (pendingAdd != null && m_packets != null)

+                    {

+                        m_packets[pendingAdd.SequenceNumber] = pendingAdd;

+                    }

+                }

+            }

+            

+            // Process all the pending removes, including updating statistics and round-trip times

+            PendingAck pendingRemove;

+            OutgoingPacket ackedPacket;

+            if (m_pendingRemoves != null)

+            {

+                while (m_pendingRemoves.Dequeue(out pendingRemove))

+                {

+                    if (m_pendingRemoves != null && m_packets != null)

+                    {

+                        if (m_packets.TryGetValue(pendingRemove.SequenceNumber, out ackedPacket))

+                        {

+                            m_packets.Remove(pendingRemove.SequenceNumber);

+

+                            // Update stats

+                            System.Threading.Interlocked.Add(ref ackedPacket.Client.UnackedBytes, -ackedPacket.Buffer.DataLength);

+

+                            if (!pendingRemove.FromResend)

+                            {

+                                // Calculate the round-trip time for this packet and its ACK

+                                int rtt = pendingRemove.RemoveTime - ackedPacket.TickCount;

+                                if (rtt > 0)

+                                    ackedPacket.Client.UpdateRoundTrip(rtt);

+                            }

+                        }

+                    }

+                }

+            }

+        }

+    }

+}