aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/OpenSim/Framework/AgentCircuitData.cs
diff options
context:
space:
mode:
authorTeravus Ovares (Dan Olivares)2009-08-12 23:18:00 -0400
committerTeravus Ovares (Dan Olivares)2009-08-12 23:18:00 -0400
commit18634e9dd8464ee7514587d0645e38f529f0bb3e (patch)
tree37fa4a37b685fb1de082a3fbd9ead1231b26f448 /OpenSim/Framework/AgentCircuitData.cs
parentMerge branch 'master' of ssh://MyConnection/var/git/opensim (diff)
downloadopensim-SC_OLD-18634e9dd8464ee7514587d0645e38f529f0bb3e.zip
opensim-SC_OLD-18634e9dd8464ee7514587d0645e38f529f0bb3e.tar.gz
opensim-SC_OLD-18634e9dd8464ee7514587d0645e38f529f0bb3e.tar.bz2
opensim-SC_OLD-18634e9dd8464ee7514587d0645e38f529f0bb3e.tar.xz
minor: comments
Diffstat (limited to 'OpenSim/Framework/AgentCircuitData.cs')
-rw-r--r--OpenSim/Framework/AgentCircuitData.cs68
1 files changed, 68 insertions, 0 deletions
diff --git a/OpenSim/Framework/AgentCircuitData.cs b/OpenSim/Framework/AgentCircuitData.cs
index c38f0c3..6472f31 100644
--- a/OpenSim/Framework/AgentCircuitData.cs
+++ b/OpenSim/Framework/AgentCircuitData.cs
@@ -32,26 +32,83 @@ using OpenMetaverse.StructuredData;
32 32
33namespace OpenSim.Framework 33namespace OpenSim.Framework
34{ 34{
35 /// <summary>
36 /// Circuit data for an agent. Connection information shared between
37 /// regions that accept UDP connections from a client
38 /// </summary>
35 public class AgentCircuitData 39 public class AgentCircuitData
36 { 40 {
41 /// <summary>
42 /// Avatar Unique Agent Identifier
43 /// </summary>
37 public UUID AgentID; 44 public UUID AgentID;
45
46 /// <summary>
47 /// Avatar's Appearance
48 /// </summary>
38 public AvatarAppearance Appearance; 49 public AvatarAppearance Appearance;
50
51 /// <summary>
52 /// Agent's root inventory folder
53 /// </summary>
39 public UUID BaseFolder; 54 public UUID BaseFolder;
55
56 /// <summary>
57 /// Base Caps path for user
58 /// </summary>
40 public string CapsPath = String.Empty; 59 public string CapsPath = String.Empty;
60
61 /// <summary>
62 /// Seed caps for neighbor regions that the user can see into
63 /// </summary>
41 public Dictionary<ulong, string> ChildrenCapSeeds; 64 public Dictionary<ulong, string> ChildrenCapSeeds;
65
66 /// <summary>
67 /// Root agent, or Child agent
68 /// </summary>
42 public bool child; 69 public bool child;
70
71 /// <summary>
72 /// Number given to the client when they log-in that they provide
73 /// as credentials to the UDP server
74 /// </summary>
43 public uint circuitcode; 75 public uint circuitcode;
76
77 /// <summary>
78 /// Agent's account first name
79 /// </summary>
44 public string firstname; 80 public string firstname;
45 public UUID InventoryFolder; 81 public UUID InventoryFolder;
82
83 /// <summary>
84 /// Agent's account last name
85 /// </summary>
46 public string lastname; 86 public string lastname;
87
88 /// <summary>
89 /// Random Unique GUID for this session. Client gets this at login and it's
90 /// only supposed to be disclosed over secure channels
91 /// </summary>
47 public UUID SecureSessionID; 92 public UUID SecureSessionID;
93
94 /// <summary>
95 /// Non secure Session ID
96 /// </summary>
48 public UUID SessionID; 97 public UUID SessionID;
98
99 /// <summary>
100 /// Position the Agent's Avatar starts in the region
101 /// </summary>
49 public Vector3 startpos; 102 public Vector3 startpos;
50 103
51 public AgentCircuitData() 104 public AgentCircuitData()
52 { 105 {
53 } 106 }
54 107
108 /// <summary>
109 /// Create AgentCircuitData from a Serializable AgentCircuitData
110 /// </summary>
111 /// <param name="cAgent"></param>
55 public AgentCircuitData(sAgentCircuitData cAgent) 112 public AgentCircuitData(sAgentCircuitData cAgent)
56 { 113 {
57 AgentID = new UUID(cAgent.AgentID); 114 AgentID = new UUID(cAgent.AgentID);
@@ -68,6 +125,10 @@ namespace OpenSim.Framework
68 ChildrenCapSeeds = cAgent.ChildrenCapSeeds; 125 ChildrenCapSeeds = cAgent.ChildrenCapSeeds;
69 } 126 }
70 127
128 /// <summary>
129 /// Pack AgentCircuitData into an OSDMap for transmission over LLSD XML or LLSD json
130 /// </summary>
131 /// <returns>map of the agent circuit data</returns>
71 public OSDMap PackAgentCircuitData() 132 public OSDMap PackAgentCircuitData()
72 { 133 {
73 OSDMap args = new OSDMap(); 134 OSDMap args = new OSDMap();
@@ -98,6 +159,10 @@ namespace OpenSim.Framework
98 return args; 159 return args;
99 } 160 }
100 161
162 /// <summary>
163 /// Unpack agent circuit data map into an AgentCiruitData object
164 /// </summary>
165 /// <param name="args"></param>
101 public void UnpackAgentCircuitData(OSDMap args) 166 public void UnpackAgentCircuitData(OSDMap args)
102 { 167 {
103 if (args["agent_id"] != null) 168 if (args["agent_id"] != null)
@@ -150,6 +215,9 @@ namespace OpenSim.Framework
150 } 215 }
151 } 216 }
152 217
218 /// <summary>
219 /// Serializable Agent Circuit Data
220 /// </summary>
153 [Serializable] 221 [Serializable]
154 public class sAgentCircuitData 222 public class sAgentCircuitData
155 { 223 {