Overview of How Regions Work - Revision history

Justincc: /* Scene Object Groups and Scene Object Parts */

2012-10-29T21:09:52Z

‎Scene Object Groups and Scene Object Parts

Justincc at 20:56, 29 October 2012

2012-10-29T20:56:29Z

Justincc: "Which regions run" section is unnecessary - this stuff is well covered in configuration

2012-10-29T20:53:11Z

"Which regions run" section is unnecessary - this stuff is well covered in configuration

Justincc: /* Scene: the Core of the Region */

2012-10-29T20:52:42Z

‎Scene: the Core of the Region

MakoBot: Robot: Cosmetic changes

2012-03-04T03:53:09Z

Robot: Cosmetic changes

Fly-man-: /* Source Enabled */

2009-09-18T20:35:32Z

‎Source Enabled

Rknop: New page: The following is based on a brief discussion between ter_afk and rknop on #opensim-dev. It's archived here so that hopefully others can benefit from it. == Scene: the Core of the Region ...

2009-09-18T19:16:48Z

New page: The following is based on a brief discussion between ter_afk and rknop on #opensim-dev. It's archived here so that hopefully others can benefit from it. == Scene: the Core of the Region ...

New page

The following is based on a brief discussion between ter_afk and rknop on #opensim-dev. It's archived here so that hopefully others can benefit from it.

== Scene: the Core of the Region ==

OpenSim.Region.Framework.Scenes.Scene is the "heart" of OpenSimulator's functionality. The method Scene.Heartbeat() starts the heartbeat going; it does this by calling the Update() method. That method is the "main loop" of the region:

<pre>
public override void Update()
{
int maintc = 0;
while (!shuttingdown)
{
</pre>

That loop is run over and over again. At the bottom of the loop is:

<pre>
maintc = Environment.TickCount - maintc;
maintc = (int)(m_timespan * 1000) - maintc;

if ((maintc < (m_timespan * 1000)) && maintc > 0)
Thread.Sleep(maintc);
}
}
</pre>

In other words, if everything else didn't take as long as one heartbeat is supposed to take, the thread goes to sleep until it's time to service the next heartbeat. This heartbeat runs about 10 times a second.

Other modules of all sorts can register heartbeat events that get called each pass through the main loop, and there are other events that modules can register for as well. (Details forthcoming....)

== Which regions run? ==

The <tt>bin/Regions/Regions.ini</tt> file determines which regions run. Here's an example:

<pre>
[Test]
RegionUUID = 4b516a07-aa32-47e4-b4d9-52116255b4d2
Location = 1000,1000
InternalAddress = 127.0.0.1
InternalPort = 9000
AllowAlternatePorts = False
ExternalHostName = SYSTEMIP
MasterAvatarFirstName = Master
MasterAvatarLastName = Avatar
MasterAvatarSandboxPassword = master_avatar_password
</pre>

← Older revision		Revision as of 21:09, 29 October 2012
Line 34:		Line 34:

	Other modules of all sorts can register heartbeat events that get called each pass through the main loop, and there are other events that modules can register for as well.		Other modules of all sorts can register heartbeat events that get called each pass through the main loop, and there are other events that modules can register for as well.
		+
		+	For information on the serializations of SOG and SOP (as used to transfer data between regions on teleport or when saved/loaded from OARs/IARs), see [[Object Formats]].

← Older revision		Revision as of 20:53, 29 October 2012
Line 28:		Line 28:

	Other modules of all sorts can register heartbeat events that get called each pass through the main loop, and there are other events that modules can register for as well.		Other modules of all sorts can register heartbeat events that get called each pass through the main loop, and there are other events that modules can register for as well.
−
−	~~== Which regions run? ==~~
−
−	~~The <tt>bin/Regions/Regions.ini</tt> file determines which regions run. Here's an example:~~
−
−	~~<source lang=ini>~~
−	~~[Test]~~
−	~~RegionUUID = 4b516a07-aa32-47e4-b4d9-52116255b4d2~~
−	~~Location = 1000,1000~~
−	~~InternalAddress = 127.0.0.1~~
−	~~InternalPort = 9000~~
−	~~AllowAlternatePorts = False~~
−	~~ExternalHostName = SYSTEMIP~~
−	~~MasterAvatarFirstName = Master~~
−	~~MasterAvatarLastName = Avatar~~
−	~~MasterAvatarSandboxPassword = master_avatar_password~~
−	~~</source>~~

@@ Line 24: / Line 24: @@
+         }
 </source>
 In other words, if everything else didn't take as long as one heartbeat is supposed to take, the thread goes to sleep until it's time to service the next heartbeat. This heartbeat runs about 10 times a second.
 Other modules of all sorts can register heartbeat events that get called each pass through the main loop, and there are other events that modules can register for as well.

@@ Line 27: / Line 27: @@
 In other words, if everything else didn't take as long as one heartbeat is supposed to take, the thread goes to sleep until it's time to service the next heartbeat. This heartbeat runs about 10 times a second.
-Other modules of all sorts can register heartbeat events that get called each pass through the main loop, and there are other events that modules can register for as well. (Details forthcoming....)
+Other modules of all sorts can register heartbeat events that get called each pass through the main loop, and there are other events that modules can register for as well.
 == Which regions run? ==

@@ Line 1: / Line 1: @@
-The following is based on a brief discussion between ter_afk and rknop on #opensim-dev.  It's archived here so that hopefully others can benefit from it.
+The following is based on a brief discussion between ter_afk and rknop on #opensim-dev. It's archived here so that hopefully others can benefit from it.
 == Scene: the Core of the Region ==
-OpenSim.Region.Framework.Scenes.Scene is the "heart" of OpenSimulator's functionality.  The method Scene.Heartbeat() starts the heartbeat going; it does this by calling the Update() method.  That method is the "main loop" of the region:
+OpenSim.Region.Framework.Scenes.Scene is the "heart" of OpenSimulator's functionality. The method Scene.Heartbeat() starts the heartbeat going; it does this by calling the Update() method. That method is the "main loop" of the region:
 <source lang=csharp>
@@ Line 13: / Line 13: @@
 </source>
-That loop is run over and over again.  At the bottom of the loop is:
+That loop is run over and over again. At the bottom of the loop is:
 <source lang=csharp>
@@ Line 25: / Line 25: @@
 </source>
-In other words, if everything else didn't take as long as one heartbeat is supposed to take, the thread goes to sleep until it's time to service the next heartbeat.  This heartbeat runs about 10 times a second.
+In other words, if everything else didn't take as long as one heartbeat is supposed to take, the thread goes to sleep until it's time to service the next heartbeat. This heartbeat runs about 10 times a second.
-Other modules of all sorts can register heartbeat events that get called each pass through the main loop, and there are other events that modules can register for as well.  (Details forthcoming....)
+Other modules of all sorts can register heartbeat events that get called each pass through the main loop, and there are other events that modules can register for as well. (Details forthcoming....)
 == Which regions run? ==
-The <tt>bin/Regions/Regions.ini</tt> file determines which regions run.  Here's an example:
+The <tt>bin/Regions/Regions.ini</tt> file determines which regions run. Here's an example:
 <source lang=ini>

@@ Line 5: / Line 5: @@
 OpenSim.Region.Framework.Scenes.Scene is the "heart" of OpenSimulator's functionality.  The method Scene.Heartbeat() starts the heartbeat going; it does this by calling the Update() method.  That method is the "main loop" of the region:
-<pre>
+<source lang=csharp>
          public override void Update()
+         {
@@ Line 11: / Line 11: @@
              while (!shuttingdown)
+             {
-</pre>
+</source>
 That loop is run over and over again.  At the bottom of the loop is:
-<pre>
+<source lang=csharp>
                  maintc = Environment.TickCount - maintc;
                  maintc = (int)(m_timespan * 1000) - maintc;
@@ Line 23: / Line 23: @@
+             }
+         }
-</pre>
+</source>
 In other words, if everything else didn't take as long as one heartbeat is supposed to take, the thread goes to sleep until it's time to service the next heartbeat.  This heartbeat runs about 10 times a second.
@@ Line 33: / Line 33: @@
 The <tt>bin/Regions/Regions.ini</tt> file determines which regions run.  Here's an example:
-<pre>
+<source lang=ini>
 [Test]
 RegionUUID = 4b516a07-aa32-47e4-b4d9-52116255b4d2
@@ Line 44: / Line 44: @@
 MasterAvatarLastName = Avatar
 MasterAvatarSandboxPassword = master_avatar_password
-</pre>
+</source>