From b099f26376a7d671eeb9113dd7611cfcb0e57de0 Mon Sep 17 00:00:00 2001
From: Justin Clark-Casey (justincc)
Date: Tue, 12 Jun 2012 02:16:36 +0100
Subject: Set IClientAPI.IsActive = false early on client removal due to ack
 timeout rather than using IsLoggingOut flag.

IsActive is more appropriate since unack timeout is not due to voluntary logout.
This is in line with operations such as manual kick that do not set the IsLoggingOut flag.
It's also slightly better race-wise since it reduces the chance of this operation clashing with another reason for client deactivation (e.g. manual kick).
---
 OpenSim/Framework/IClientAPI.cs | 9 +++------
 1 file changed, 3 insertions(+), 6 deletions(-)

(limited to 'OpenSim/Framework/IClientAPI.cs')

diff --git a/OpenSim/Framework/IClientAPI.cs b/OpenSim/Framework/IClientAPI.cs
index f8b6a84..2ea6de5 100644
--- a/OpenSim/Framework/IClientAPI.cs
+++ b/OpenSim/Framework/IClientAPI.cs
@@ -741,22 +741,19 @@ namespace OpenSim.Framework
         string Name { get; }
 
         /// <summary>
-        /// True if the client is active (sending and receiving new UDP messages).  False if the client is closing.
+        /// True if the client is active (sending and receiving new UDP messages).  False if the client is being closed.
         /// </summary>
         bool IsActive { get; set; }
 
         /// <summary>
-        /// Set if the client is closing due to a logout request or because of too much time since last ack.
+        /// Set if the client is closing due to a logout request
         /// </summary>
         /// <remarks>
         /// Do not use this flag if you want to know if the client is closing, since it will not be set in other
         /// circumstances (e.g. if a child agent is closed or the agent is kicked off the simulator).  Use IsActive
-        /// instead.
+        /// instead with a IClientAPI.SceneAgent.IsChildAgent check if necessary.
         ///
         /// Only set for root agents.
-        ///
-        /// TODO: Too much time since last ack should probably be a separate property, or possibly part of a state
-        /// machine.
         /// </remarks>
         bool IsLoggingOut { get; set; }
         
-- 
cgit v1.1