aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/OpenSim/Framework/IClientAPI.cs
diff options
context:
space:
mode:
Diffstat (limited to 'OpenSim/Framework/IClientAPI.cs')
-rw-r--r--OpenSim/Framework/IClientAPI.cs22
1 files changed, 16 insertions, 6 deletions
diff --git a/OpenSim/Framework/IClientAPI.cs b/OpenSim/Framework/IClientAPI.cs
index 869b069..f8b6a84 100644
--- a/OpenSim/Framework/IClientAPI.cs
+++ b/OpenSim/Framework/IClientAPI.cs
@@ -740,14 +740,24 @@ namespace OpenSim.Framework
740 /// </summary> 740 /// </summary>
741 string Name { get; } 741 string Name { get; }
742 742
743 /// <value> 743 /// <summary>
744 /// Determines whether the client thread is doing anything or not. 744 /// True if the client is active (sending and receiving new UDP messages). False if the client is closing.
745 /// </value> 745 /// </summary>
746 bool IsActive { get; set; } 746 bool IsActive { get; set; }
747 747
748 /// <value> 748 /// <summary>
749 /// Determines whether the client is or has been removed from a given scene 749 /// Set if the client is closing due to a logout request or because of too much time since last ack.
750 /// </value> 750 /// </summary>
751 /// <remarks>
752 /// Do not use this flag if you want to know if the client is closing, since it will not be set in other
753 /// circumstances (e.g. if a child agent is closed or the agent is kicked off the simulator). Use IsActive
754 /// instead.
755 ///
756 /// Only set for root agents.
757 ///
758 /// TODO: Too much time since last ack should probably be a separate property, or possibly part of a state
759 /// machine.
760 /// </remarks>
751 bool IsLoggingOut { get; set; } 761 bool IsLoggingOut { get; set; }
752 762
753 bool SendLogoutPacketWhenClosing { set; } 763 bool SendLogoutPacketWhenClosing { set; }