ogb912/opensim
1
0
Fork 0
mirror of https://github.com/opensim/opensim.git synced 2026-08-07 09:45:47 +08:00
Code Issues Packages Projects Releases Wiki Activity

Improve some method doc for LLUDPClient, LLUDPServer and UnackedPacketCollection

Browse Source
This commit is contained in:
Justin Clark-Casey (justincc)
2011-10-12 19:22:30 +01:00
parent fe3594c5ea
commit f9ffd2538f
3 changed files with 39 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
OpenSim/Region/ClientStack/Linden/UDP/LLUDPClient.cs
View File

@@ -169,7 +169,16 @@ namespace OpenSim.Region.ClientStack.LindenUDP
/// <param name="circuitCode">Circuit code for this connection</param>
/// <param name="agentID">AgentID for the connected agent</param>
/// <param name="remoteEndPoint">Remote endpoint for this connection</param>
public LLUDPClient(LLUDPServer server, ThrottleRates rates, TokenBucket parentThrottle, uint circuitCode, UUID agentID, IPEndPoint remoteEndPoint, int defaultRTO, int maxRTO)
/// <param name="defaultRTO">
/// Default retransmission timeout for unacked packets. The RTO will never drop
/// beyond this number.
/// </param>
/// <param name="maxRTO">
/// The maximum retransmission timeout for unacked packets. The RTO will never exceed this number.
/// </param>
public LLUDPClient(
LLUDPServer server, ThrottleRates rates, TokenBucket parentThrottle, uint circuitCode, UUID agentID,
IPEndPoint remoteEndPoint, int defaultRTO, int maxRTO)
{
AgentID = agentID;
RemoteEndPoint = remoteEndPoint;
@@ -197,7 +206,7 @@ namespace OpenSim.Region.ClientStack.LindenUDP
m_throttleCategories[i] = new TokenBucket(m_throttleCategory, rates.GetRate(type));
}
// Default the retransmission timeout to three seconds
// Default the retransmission timeout to one second
RTO = m_defaultRTO;
// Initialize this to a sane value to prevent early disconnects
@@ -262,9 +271,9 @@ namespace OpenSim.Region.ClientStack.LindenUDP
/// <summary>
/// Return statistics information about client packet queues.
/// </summary>
///
/// <remarks>
/// FIXME: This should really be done in a more sensible manner rather than sending back a formatted string.
///
/// </remarks>
/// <returns></returns>
public string GetStats()
{
@@ -606,8 +615,7 @@ namespace OpenSim.Region.ClientStack.LindenUDP
/// Does an early check to see if this queue empty callback is already
/// running, then asynchronously firing the event
/// </summary>
/// <param name="throttleIndex">Throttle category to fire the callback
/// for</param>
/// <param name="categories">Throttle categories to fire the callback for</param>
private void BeginFireQueueEmpty(ThrottleOutPacketTypeFlags categories)
{
if (m_nextOnQueueEmpty != 0 && (Environment.TickCount & Int32.MaxValue) >= m_nextOnQueueEmpty)
@@ -694,4 +702,4 @@ namespace OpenSim.Region.ClientStack.LindenUDP
}
}
}
}
}