From a3c0e3ed260a8a76e3009e99162cdcb8142ea1b1 Mon Sep 17 00:00:00 2001
From: Justin Clark-Casey (justincc)
Date: Tue, 9 Oct 2012 22:19:47 +0100
Subject: minor: elaborate method doc on Scene.NewUserConnection()
---
OpenSim/Region/Framework/Scenes/Scene.cs | 19 +++++++++++++------
1 file changed, 13 insertions(+), 6 deletions(-)
(limited to 'OpenSim/Region/Framework')
diff --git a/OpenSim/Region/Framework/Scenes/Scene.cs b/OpenSim/Region/Framework/Scenes/Scene.cs
index 671feda..ed88571 100644
--- a/OpenSim/Region/Framework/Scenes/Scene.cs
+++ b/OpenSim/Region/Framework/Scenes/Scene.cs
@@ -3461,11 +3461,9 @@ namespace OpenSim.Region.Framework.Scenes
///
/// Do the work necessary to initiate a new user connection for a particular scene.
- /// At the moment, this consists of setting up the caps infrastructure
- /// The return bool should allow for connections to be refused, but as not all calling paths
- /// take proper notice of it let, we allowed banned users in still.
///
/// CircuitData of the agent who is connecting
+ ///
/// Outputs the reason for the false response on this string
/// True if the region accepts this agent. False if it does not. False will
/// also return a reason.
@@ -3476,10 +3474,20 @@ namespace OpenSim.Region.Framework.Scenes
///
/// Do the work necessary to initiate a new user connection for a particular scene.
- /// At the moment, this consists of setting up the caps infrastructure
+ ///
+ ///
+ /// The return bool should allow for connections to be refused, but as not all calling paths
+ /// take proper notice of it yet, we still allowed banned users in.
+ ///
+ /// At the moment this method consists of setting up the caps infrastructure
/// The return bool should allow for connections to be refused, but as not all calling paths
/// take proper notice of it let, we allowed banned users in still.
- ///
+ ///
+ /// This method is called by the login service (in the case of login) or another simulator (in the case of region
+ /// cross or teleport) to initiate the connection. It is not triggered by the viewer itself - the connection
+ /// is activated later when the viewer sends the initial UseCircuitCodePacket UDP packet (in the case of
+ /// the LLUDP stack).
+ ///
/// CircuitData of the agent who is connecting
/// Outputs the reason for the false response on this string
/// True for normal presence. False for NPC
@@ -3566,7 +3574,6 @@ namespace OpenSim.Region.Framework.Scenes
return false;
}
-
ScenePresence sp = GetScenePresence(agent.AgentID);
if (sp != null && !sp.IsChildAgent)
--
cgit v1.1