From 61b537215328499155c58f46e6338d459aba87ec Mon Sep 17 00:00:00 2001
From: John Hurliman
Date: Tue, 6 Oct 2009 12:13:16 -0700
Subject: * Added missing references to prebuild.xml and commented out the
 LindenUDP tests until a new test harness is written * Clients are no longer
 disconnected when a packet handler crashes. We'll see how this works out in
 practice * Added documentation and cleanup, getting ready for the first
 public push * Deleted an old LLUDP file

---
 OpenSim/Region/ClientStack/LindenUDP/OutgoingPacket.cs | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

(limited to 'OpenSim/Region/ClientStack/LindenUDP/OutgoingPacket.cs')

diff --git a/OpenSim/Region/ClientStack/LindenUDP/OutgoingPacket.cs b/OpenSim/Region/ClientStack/LindenUDP/OutgoingPacket.cs
index 69b0c5f..1a1a1cb 100644
--- a/OpenSim/Region/ClientStack/LindenUDP/OutgoingPacket.cs
+++ b/OpenSim/Region/ClientStack/LindenUDP/OutgoingPacket.cs
@@ -31,6 +31,13 @@ using OpenMetaverse;
 
 namespace OpenSim.Region.ClientStack.LindenUDP
 {
+    /// <summary>
+    /// Holds a reference to the <seealso cref="LLUDPClient"/> this packet is
+    /// destined for, along with the serialized packet data, sequence number
+    /// (if this is a resend), number of times this packet has been resent,
+    /// the time of the last resend, and the throttling category for this
+    /// packet
+    /// </summary>
     public sealed class OutgoingPacket
     {
         /// <summary>Client this packet is destined for</summary>
@@ -46,6 +53,13 @@ namespace OpenSim.Region.ClientStack.LindenUDP
         /// <summary>Category this packet belongs to</summary>
         public ThrottleOutPacketType Category;
 
+        /// <summary>
+        /// Default constructor
+        /// </summary>
+        /// <param name="client">Reference to the client this packet is destined for</param>
+        /// <param name="buffer">Serialized packet data. If the flags or sequence number
+        /// need to be updated, they will be injected directly into this binary buffer</param>
+        /// <param name="category">Throttling category for this packet</param>
         public OutgoingPacket(LLUDPClient client, UDPPacketBuffer buffer, ThrottleOutPacketType category)
         {
             Client = client;
-- 
cgit v1.1