aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/OpenSim
diff options
context:
space:
mode:
authorJustin Clark-Casey (justincc)2012-10-10 00:48:20 +0100
committerJustin Clark-Casey (justincc)2012-10-10 00:48:20 +0100
commit528085adefdd105aca2621c747fefe728ea8c218 (patch)
tree9cea52546c761e7ad947be4b36d2e67732cad6b0 /OpenSim
parentLock on AgentCircuitData during Scene.AddClient() and RemoveClient() to preve... (diff)
downloadopensim-SC_OLD-528085adefdd105aca2621c747fefe728ea8c218.zip
opensim-SC_OLD-528085adefdd105aca2621c747fefe728ea8c218.tar.gz
opensim-SC_OLD-528085adefdd105aca2621c747fefe728ea8c218.tar.bz2
opensim-SC_OLD-528085adefdd105aca2621c747fefe728ea8c218.tar.xz
minor: Add method doc to EventManager.OnNewClient, OnClientLogin, ClientClosed, OnRemovePresence that any long-running operations should be launched on a thread separate to the event thread.
Diffstat (limited to 'OpenSim')
-rw-r--r--OpenSim/Region/Framework/Scenes/EventManager.cs14
1 files changed, 14 insertions, 0 deletions
diff --git a/OpenSim/Region/Framework/Scenes/EventManager.cs b/OpenSim/Region/Framework/Scenes/EventManager.cs
index a8ff218..4c49b71 100644
--- a/OpenSim/Region/Framework/Scenes/EventManager.cs
+++ b/OpenSim/Region/Framework/Scenes/EventManager.cs
@@ -121,13 +121,21 @@ namespace OpenSim.Region.Framework.Scenes
121 /// </summary> 121 /// </summary>
122 /// <remarks> 122 /// <remarks>
123 /// This is triggered for both child and root agent client connections. 123 /// This is triggered for both child and root agent client connections.
124 ///
124 /// Triggered before OnClientLogin. 125 /// Triggered before OnClientLogin.
126 ///
127 /// This is triggered under per-agent lock. So if you want to perform any long-running operations, please
128 /// do this on a separate thread.
125 /// </remarks> 129 /// </remarks>
126 public event OnNewClientDelegate OnNewClient; 130 public event OnNewClientDelegate OnNewClient;
127 131
128 /// <summary> 132 /// <summary>
129 /// Fired if the client entering this sim is doing so as a new login 133 /// Fired if the client entering this sim is doing so as a new login
130 /// </summary> 134 /// </summary>
135 /// <remarks>
136 /// This is triggered under per-agent lock. So if you want to perform any long-running operations, please
137 /// do this on a separate thread.
138 /// </remarks>
131 public event Action<IClientAPI> OnClientLogin; 139 public event Action<IClientAPI> OnClientLogin;
132 140
133 public delegate void OnNewPresenceDelegate(ScenePresence presence); 141 public delegate void OnNewPresenceDelegate(ScenePresence presence);
@@ -149,6 +157,9 @@ namespace OpenSim.Region.Framework.Scenes
149 /// <remarks> 157 /// <remarks>
150 /// Triggered in <see cref="OpenSim.Region.Framework.Scenes.Scene.AddNewClient"/> which is used by both 158 /// Triggered in <see cref="OpenSim.Region.Framework.Scenes.Scene.AddNewClient"/> which is used by both
151 /// <see cref="OpenSim.Framework.PresenceType.User">users</see> and <see cref="OpenSim.Framework.PresenceType.Npc">NPCs</see> 159 /// <see cref="OpenSim.Framework.PresenceType.User">users</see> and <see cref="OpenSim.Framework.PresenceType.Npc">NPCs</see>
160 ///
161 /// Triggered under per-agent lock. So if you want to perform any long-running operations, please
162 /// do this on a separate thread.
152 /// </remarks> 163 /// </remarks>
153 public event OnRemovePresenceDelegate OnRemovePresence; 164 public event OnRemovePresenceDelegate OnRemovePresence;
154 165
@@ -425,6 +436,9 @@ namespace OpenSim.Region.Framework.Scenes
425 /// </summary> 436 /// </summary>
426 /// <remarks> 437 /// <remarks>
427 /// At the point of firing, the scene still contains the client's scene presence. 438 /// At the point of firing, the scene still contains the client's scene presence.
439 ///
440 /// This is triggered under per-agent lock. So if you want to perform any long-running operations, please
441 /// do this on a separate thread.
428 /// </remarks> 442 /// </remarks>
429 public event ClientClosed OnClientClosed; 443 public event ClientClosed OnClientClosed;
430 444