From e6c0267def09280761a6f2cbc668b2d0ad7f2753 Mon Sep 17 00:00:00 2001
From: Justin Clark-Casey (justincc)
Date: Fri, 27 Sep 2013 19:14:21 +0100
Subject: refactor: rename Scene.IncomingCloseAgent() to CloseAgent() in order
to make it clear that all non-clientstack callers should be using this rather
than RemoveClient() in order to step through the ScenePresence state machine
properly.
Adds IScene.CloseAgent() to replace RemoveClient()
---
OpenSim/Framework/IScene.cs | 12 +++++++-----
1 file changed, 7 insertions(+), 5 deletions(-)
(limited to 'OpenSim/Framework/IScene.cs')
diff --git a/OpenSim/Framework/IScene.cs b/OpenSim/Framework/IScene.cs
index 8164f41..c3df37b 100644
--- a/OpenSim/Framework/IScene.cs
+++ b/OpenSim/Framework/IScene.cs
@@ -86,7 +86,7 @@ namespace OpenSim.Framework
event restart OnRestart;
///
- /// Add a new client and create a presence for it. All clients except initial login clients will starts off as a child agent
+ /// Add a new agent. All agents except initial login clients will starts off as a child agent
/// - the later agent crossing will promote it to a root agent.
///
///
@@ -96,14 +96,16 @@ namespace OpenSim.Framework
ISceneAgent AddNewClient(IClientAPI client, PresenceType type);
///
- /// Remove the given client from the scene.
+ /// Tell a single agent to disconnect from the region.
///
///
- /// Close the neighbour child agents associated with this client.
- void RemoveClient(UUID agentID, bool closeChildAgents);
+ ///
+ /// Force the agent to close even if it might be in the middle of some other operation. You do not want to
+ /// force unless you are absolutely sure that the agent is dead and a normal close is not working.
+ ///
+ bool CloseAgent(UUID agentID, bool force);
void Restart();
- //RegionInfo OtherRegionUp(RegionInfo thisRegion);
string GetSimulatorVersion();
--
cgit v1.1