From 2349dc2e27becef11ca1eda2602a99f1a583e6f7 Mon Sep 17 00:00:00 2001
From: Teravus Ovares
Date: Mon, 10 Dec 2007 21:12:38 +0000
Subject: * Added comments to many methods in the listed files.
---
.../Scenes/SceneCommunicationService.cs | 23 ++++++++++++++++++----
1 file changed, 19 insertions(+), 4 deletions(-)
(limited to 'OpenSim/Region/Environment/Scenes/SceneCommunicationService.cs')
diff --git a/OpenSim/Region/Environment/Scenes/SceneCommunicationService.cs b/OpenSim/Region/Environment/Scenes/SceneCommunicationService.cs
index 68bb3b5..ba9bf7b 100644
--- a/OpenSim/Region/Environment/Scenes/SceneCommunicationService.cs
+++ b/OpenSim/Region/Environment/Scenes/SceneCommunicationService.cs
@@ -189,7 +189,8 @@ namespace OpenSim.Region.Environment.Scenes
}
///
- ///
+ /// This informs all neighboring regions about agent "avatar".
+ /// Calls an asynchronous method to do so.. so it doesn't lag the sim.
///
public void EnableNeighbourChildAgents(ScenePresence avatar, List lstneighbours)
{
@@ -222,6 +223,10 @@ namespace OpenSim.Region.Environment.Scenes
}
}
}
+ ///
+ /// This informs a single neighboring region about agent "avatar".
+ /// Calls an asynchronous method to do so.. so it doesn't lag the sim.
+ ///
public void InformNeighborChildAgent(ScenePresence avatar, RegionInfo region, List neighbours)
{
AgentCircuitData agent = avatar.ControllingClient.RequestClientInfo();
@@ -260,7 +265,10 @@ namespace OpenSim.Region.Environment.Scenes
MainLog.Instance.Notice("INTERGRID", "Failed to inform neighbors that I'm here");
}
}
-
+ ///
+ /// Called by scene when region is initialized (not always when it's listening for agents)
+ /// This is an inter-region message that informs the surrounding neighbors that the sim is up.
+ ///
public void InformNeighborsThatRegionisUp(RegionInfo region)
{
//MainLog.Instance.Verbose("INTER", debugRegionName + ": SceneCommunicationService: Sending InterRegion Notification that region is up " + region.RegionName);
@@ -286,6 +294,13 @@ namespace OpenSim.Region.Environment.Scenes
}
public delegate void SendChildAgentDataUpdateDelegate(ulong regionHandle, ChildAgentDataUpdate cAgentData);
+ ///
+ /// This informs all neighboring regions about the settings of it's child agent.
+ /// Calls an asynchronous method to do so.. so it doesn't lag the sim.
+ ///
+ /// This contains information, such as, Draw Distance, Camera location, Current Position, Current throttle settings, etc.
+ ///
+ ///
private void SendChildAgentDataUpdateAsync(ulong regionHandle, ChildAgentDataUpdate cAgentData)
{
MainLog.Instance.Notice("INTERGRID", "Informing a neighbor about my agent.");
@@ -317,7 +332,7 @@ namespace OpenSim.Region.Environment.Scenes
///
- ///
+ /// Helper function to request neighbors from grid-comms
///
///
///
@@ -328,7 +343,7 @@ namespace OpenSim.Region.Environment.Scenes
}
///
- ///
+ /// Requests map blocks in area of minX, maxX, minY, MaxY in world cordinates
///
///
///
--
cgit v1.1