aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/OpenSim/Region/ClientStack/Linden/UDP/LLUDPClient.cs
diff options
context:
space:
mode:
authorJustin Clark-Casey (justincc)2011-10-12 19:22:30 +0100
committerJustin Clark-Casey (justincc)2011-10-12 19:22:30 +0100
commitf9ffd2538f3bf300e8f751258a6129fb780b5b0a (patch)
tree223fe9d64772149cc60e5f2398a815044857720b /OpenSim/Region/ClientStack/Linden/UDP/LLUDPClient.cs
parentStart recording object updates per second statistic (analogue of agent update... (diff)
downloadopensim-SC_OLD-f9ffd2538f3bf300e8f751258a6129fb780b5b0a.zip
opensim-SC_OLD-f9ffd2538f3bf300e8f751258a6129fb780b5b0a.tar.gz
opensim-SC_OLD-f9ffd2538f3bf300e8f751258a6129fb780b5b0a.tar.bz2
opensim-SC_OLD-f9ffd2538f3bf300e8f751258a6129fb780b5b0a.tar.xz
Improve some method doc for LLUDPClient, LLUDPServer and UnackedPacketCollection
Diffstat (limited to 'OpenSim/Region/ClientStack/Linden/UDP/LLUDPClient.cs')
-rw-r--r--OpenSim/Region/ClientStack/Linden/UDP/LLUDPClient.cs22
1 files changed, 15 insertions, 7 deletions
diff --git a/OpenSim/Region/ClientStack/Linden/UDP/LLUDPClient.cs b/OpenSim/Region/ClientStack/Linden/UDP/LLUDPClient.cs
index ca5501d..31cc515 100644
--- a/OpenSim/Region/ClientStack/Linden/UDP/LLUDPClient.cs
+++ b/OpenSim/Region/ClientStack/Linden/UDP/LLUDPClient.cs
@@ -169,7 +169,16 @@ namespace OpenSim.Region.ClientStack.LindenUDP
169 /// <param name="circuitCode">Circuit code for this connection</param> 169 /// <param name="circuitCode">Circuit code for this connection</param>
170 /// <param name="agentID">AgentID for the connected agent</param> 170 /// <param name="agentID">AgentID for the connected agent</param>
171 /// <param name="remoteEndPoint">Remote endpoint for this connection</param> 171 /// <param name="remoteEndPoint">Remote endpoint for this connection</param>
172 public LLUDPClient(LLUDPServer server, ThrottleRates rates, TokenBucket parentThrottle, uint circuitCode, UUID agentID, IPEndPoint remoteEndPoint, int defaultRTO, int maxRTO) 172 /// <param name="defaultRTO">
173 /// Default retransmission timeout for unacked packets. The RTO will never drop
174 /// beyond this number.
175 /// </param>
176 /// <param name="maxRTO">
177 /// The maximum retransmission timeout for unacked packets. The RTO will never exceed this number.
178 /// </param>
179 public LLUDPClient(
180 LLUDPServer server, ThrottleRates rates, TokenBucket parentThrottle, uint circuitCode, UUID agentID,
181 IPEndPoint remoteEndPoint, int defaultRTO, int maxRTO)
173 { 182 {
174 AgentID = agentID; 183 AgentID = agentID;
175 RemoteEndPoint = remoteEndPoint; 184 RemoteEndPoint = remoteEndPoint;
@@ -197,7 +206,7 @@ namespace OpenSim.Region.ClientStack.LindenUDP
197 m_throttleCategories[i] = new TokenBucket(m_throttleCategory, rates.GetRate(type)); 206 m_throttleCategories[i] = new TokenBucket(m_throttleCategory, rates.GetRate(type));
198 } 207 }
199 208
200 // Default the retransmission timeout to three seconds 209 // Default the retransmission timeout to one second
201 RTO = m_defaultRTO; 210 RTO = m_defaultRTO;
202 211
203 // Initialize this to a sane value to prevent early disconnects 212 // Initialize this to a sane value to prevent early disconnects
@@ -262,9 +271,9 @@ namespace OpenSim.Region.ClientStack.LindenUDP
262 /// <summary> 271 /// <summary>
263 /// Return statistics information about client packet queues. 272 /// Return statistics information about client packet queues.
264 /// </summary> 273 /// </summary>
265 /// 274 /// <remarks>
266 /// FIXME: This should really be done in a more sensible manner rather than sending back a formatted string. 275 /// FIXME: This should really be done in a more sensible manner rather than sending back a formatted string.
267 /// 276 /// </remarks>
268 /// <returns></returns> 277 /// <returns></returns>
269 public string GetStats() 278 public string GetStats()
270 { 279 {
@@ -606,8 +615,7 @@ namespace OpenSim.Region.ClientStack.LindenUDP
606 /// Does an early check to see if this queue empty callback is already 615 /// Does an early check to see if this queue empty callback is already
607 /// running, then asynchronously firing the event 616 /// running, then asynchronously firing the event
608 /// </summary> 617 /// </summary>
609 /// <param name="throttleIndex">Throttle category to fire the callback 618 /// <param name="categories">Throttle categories to fire the callback for</param>
610 /// for</param>
611 private void BeginFireQueueEmpty(ThrottleOutPacketTypeFlags categories) 619 private void BeginFireQueueEmpty(ThrottleOutPacketTypeFlags categories)
612 { 620 {
613 if (m_nextOnQueueEmpty != 0 && (Environment.TickCount & Int32.MaxValue) >= m_nextOnQueueEmpty) 621 if (m_nextOnQueueEmpty != 0 && (Environment.TickCount & Int32.MaxValue) >= m_nextOnQueueEmpty)
@@ -694,4 +702,4 @@ namespace OpenSim.Region.ClientStack.LindenUDP
694 } 702 }
695 } 703 }
696 } 704 }
697} 705} \ No newline at end of file