Common OpenSimulator simulator code More...

Inheritance diagram for OpenSim.OpenSimBase:

Collaboration diagram for OpenSim.OpenSimBase:

Classes
class	SimStatusHandler
	Handler to supply the current status of this sim More...

class	UXSimStatusHandler
	Handler to supply the current extended status of this sim to a user configured URI Sends the statistical data in a json serialization If the request contains a key, "callback" the response will be wrappend in the associated value for jsonp used with ajax/javascript More...

class	XSimStatusHandler
	Handler to supply the current extended status of this sim Sends the statistical data in a json serialization More...

Public Member Functions
	OpenSimBase (IConfigSource configSource)
	Constructor. More...

void	CreateRegion (RegionInfo regionInfo, bool portadd_flag, out IScene scene)
	Execute the region creation process. This includes setting up scene infrastructure. More...

void	CreateRegion (RegionInfo regionInfo, out IScene scene)
	Execute the region creation process. This includes setting up scene infrastructure. More...

void	CreateRegion (RegionInfo regionInfo, bool portadd_flag, bool do_post_init, out IScene mscene)
	Execute the region creation process. This includes setting up scene infrastructure. More...

void	RemoveRegion (Scene scene, bool cleanup)

void	RemoveRegion (string name, bool cleanUp)

void	CloseRegion (Scene scene)
	Remove a region from the simulator without deleting it permanently. More...

void	CloseRegion (string name)
	Remove a region from the simulator without deleting it permanently. More...

void	GetRunTime (out string starttime, out string uptime)
	Get the start time and up time of Region server More...

void	GetAvatarNumber (out int usernum)
	Get the number of the avatars in the Region server More...

void	GetRegionNumber (out int regionnum)
	Get the number of regions More...

bool	CreateEstate (RegionInfo regInfo, Dictionary< string, EstateSettings > estatesByName, string estateName)
	Create an estate with an initial region. More...

bool	PopulateRegionEstateInfo (RegionInfo regInfo)
	Load the estate information for the provided RegionInfo object. More...

Public Member Functions inherited from OpenSim.Framework.Servers.BaseOpenSimServer
	BaseOpenSimServer ()

virtual void	Startup ()
	Performs initialisation of the scene, such as loading configuration from disk. More...

string	StatReport (IOSHttpRequest httpRequest)

Public Member Functions inherited from OpenSim.Framework.Servers.ServerBase
	ServerBase ()

void	LogEnvironmentInformation ()
	Log information about the circumstances in which we're running (OpenSimulator version number, CLR details, etc.). More...

void	RegisterCommonAppenders (IConfig startupConfig)

void	RegisterCommonCommands ()
	Register common commands once m_console has been set if it is going to be set More...

void	RegisterCommonComponents (IConfigSource configSource)

virtual void	HandleShow (string module, string[] cmd)

string	GetVersionText ()

virtual void	HandleThreadsAbort (string module, string[] cmd)

virtual void	Shutdown ()

Public Attributes
const string	ESTATE_SECTION_NAME = "Estates"

string	userStatsURI = String.Empty

string	managedStatsURI = String.Empty

ConsoleCommand	CreateAccount = null

List< IApplicationPlugin >	m_plugins = new List<IApplicationPlugin>()

Protected Member Functions
virtual void	LoadConfigSettings (IConfigSource configSource)

virtual void	ReadExtraConfigSettings ()

virtual void	LoadPlugins ()

override List< string >	GetHelpTopics ()
	Provides a list of help topics that are available. Overriding classes should append their topics to the information returned when the base method is called. More...

override void	StartupSpecific ()
	Performs startup specific to the region server, including initialization of the scene such as loading configuration from disk. More...

virtual void	AddPluginCommands (ICommandConsole console)

override void	Initialize ()

Scene	SetupScene (RegionInfo regionInfo)
	Create a scene and its initial base structures. More...

Scene	SetupScene (RegionInfo regionInfo, int proxyOffset, IConfigSource configSource)
	Create a scene and its initial base structures. More...

override Scene	CreateScene (RegionInfo regionInfo, ISimulationDataService simDataService, IEstateDataService estateDataService, AgentCircuitManager circuitManager)

virtual void	HandleRestartRegion (RegionInfo whichRegion)

override void	ShutdownSpecific ()
	Performs any last-minute sanity checking and shuts down the region server More...

Protected Member Functions inherited from OpenSim.RegionApplicationBase
override void	StartupSpecific ()
	Must be overriden by child classes for their own server specific startup behaviour. More...

Protected Member Functions inherited from OpenSim.Framework.Servers.BaseOpenSimServer
void	LogDiagnostics (object source, ElapsedEventArgs e)
	Print statistics to the logfile, if they are active More...

Protected Member Functions inherited from OpenSim.Framework.Servers.ServerBase
void	CreatePIDFile (string path)

void	RemovePIDFile ()

virtual void	HandleScript (string module, string[] parms)

void	RunCommandScript (string fileName)
	Run an optional startup list of commands More...

string	GetUptimeReport ()
	Return a report about the uptime of this server More...

void	ShowInfo ()

void	EnhanceVersionInformation ()
	Enhance the version string with extra information if it's available. More...

string	GetThreadsReport ()
	Get a report about the registered threads in this server. More...

void	Notice (string msg)
	Console output is only possible if a console has been established. That is something that cannot be determined within this class. So all attempts to use the console MUST be verified. More...

void	Notice (string format, params object[] components)
	Console output is only possible if a console has been established. That is something that cannot be determined within this class. So all attempts to use the console MUST be verified. More...

Protected Attributes
string	proxyUrl

int	proxyOffset = 0

bool	m_autoCreateClientStack = true

const string	DEFAULT_PRIM_BACKUP_FILENAME = "prim-backup.xml"

ConfigSettings	m_configSettings

ConfigurationLoader	m_configLoader

EnvConfigSource	m_EnvConfigSource = new EnvConfigSource()

IRegistryCore	m_applicationRegistry = new RegistryCore()

Protected Attributes inherited from OpenSim.RegionApplicationBase
Dictionary< EndPoint, uint >	m_clientCircuits = new Dictionary<EndPoint, uint>()

NetworkServersInfo	m_networkServersInfo

uint	m_httpServerPort

ISimulationDataService	m_simulationDataService

IEstateDataService	m_estateDataService

Protected Attributes inherited from OpenSim.Framework.Servers.BaseOpenSimServer
string	m_osSecret = String.Empty
	Random uuid for private data More...

BaseHttpServer	m_httpServer

Protected Attributes inherited from OpenSim.Framework.Servers.ServerBase
ICommandConsole	m_console
	Console to be used for any command line output. Can be null, in which case there should be no output. More...

OpenSimAppender	m_consoleAppender

FileAppender	m_logFileAppender

DateTime	m_startuptime

string	m_startupDirectory = Environment.CurrentDirectory

string	m_pidFile = String.Empty

ServerStatsCollector	m_serverStatsCollector

string	m_version
	Server version information. Usually VersionInfo + information about git commit, operating system, etc. More...

Properties
bool	EnableInitialPluginLoad `[get, set]`
	Allow all plugin loading to be disabled for tests/debug. More...

bool	LoadEstateDataService `[get, set]`
	Control whether we attempt to load an estate data service. More...

ConfigSettings	ConfigurationSettings `[get, set]`

OpenSimConfigSource	ConfigSource `[get, set]`

EnvConfigSource	envConfigSource `[get]`

uint	HttpServerPort `[get]`

IRegistryCore	ApplicationRegistry `[get]`

Properties inherited from OpenSim.RegionApplicationBase
SceneManager	SceneManager `[get, set]`

NetworkServersInfo	NetServersInfo `[get]`

ISimulationDataService	SimulationDataService `[get]`

IEstateDataService	EstateDataService `[get]`

Properties inherited from OpenSim.Framework.Servers.BaseOpenSimServer
bool	SuppressExit `[get, set]`
	Used by tests to suppress Environment.Exit(0) so that post-run operations are possible. More...

BaseHttpServer	HttpServer `[get]`

string	osSecret `[get]`

Properties inherited from OpenSim.Framework.Servers.ServerBase
IConfigSource	Config `[get, set]`

Additional Inherited Members
Static Public Member Functions inherited from OpenSim.Framework.Servers.ServerBase
static string	GetThreadPoolReport ()
	Get a thread pool report. More...

Detailed Description

Common OpenSimulator simulator code

Definition at line 58 of file OpenSimBase.cs.

Constructor & Destructor Documentation

OpenSim.OpenSimBase.OpenSimBase ( IConfigSource configSource )

inline

Constructor.

Parameters

configSource

Definition at line 145 of file OpenSimBase.cs.

Here is the call graph for this function:

Member Function Documentation

virtual void OpenSim.OpenSimBase.AddPluginCommands ( ICommandConsole console )

inlineprotectedvirtual

Definition at line 282 of file OpenSimBase.cs.

Here is the call graph for this function:

Here is the caller graph for this function:

void OpenSim.OpenSimBase.CloseRegion ( Scene scene )

inline

Remove a region from the simulator without deleting it permanently.

Parameters

scene

Returns

Definition at line 716 of file OpenSimBase.cs.

Here is the caller graph for this function:

void OpenSim.OpenSimBase.CloseRegion ( string name )

inline

Remove a region from the simulator without deleting it permanently.

Parameters

name

Returns

Definition at line 735 of file OpenSimBase.cs.

Here is the call graph for this function:

bool OpenSim.OpenSimBase.CreateEstate	(	RegionInfo	regInfo,
		Dictionary< string, EstateSettings >	estatesByName,
		string	estateName
	)

inline

Create an estate with an initial region.

This method doesn't allow an estate to be created with the same name as existing estates.

Parameters

regInfo
estatesByName	A list of estate names that already exist.
estateName	Estate name to create if already known

Returns: true if the estate was created, false otherwise

Definition at line 943 of file OpenSimBase.cs.

Here is the caller graph for this function:

void OpenSim.OpenSimBase.CreateRegion	(	RegionInfo	regionInfo,
		bool	portadd_flag,
		out IScene	scene
	)

inline

Execute the region creation process. This includes setting up scene infrastructure.

Parameters

regionInfo
portadd_flag

Returns

Definition at line 365 of file OpenSimBase.cs.

Here is the caller graph for this function:

void OpenSim.OpenSimBase.CreateRegion	(	RegionInfo	regionInfo,
		out IScene	scene
	)

inline

Execute the region creation process. This includes setting up scene infrastructure.

Parameters

regionInfo

Returns

Definition at line 375 of file OpenSimBase.cs.

Here is the call graph for this function:

void OpenSim.OpenSimBase.CreateRegion	(	RegionInfo	regionInfo,
		bool	portadd_flag,
		bool	do_post_init,
		out IScene	mscene
	)

inline

Execute the region creation process. This includes setting up scene infrastructure.

Parameters

regionInfo
portadd_flag
do_post_init

Returns

Definition at line 387 of file OpenSimBase.cs.

Here is the call graph for this function:

override Scene OpenSim.OpenSimBase.CreateScene	(	RegionInfo	regionInfo,
		ISimulationDataService	simDataService,
		IEstateDataService	estateDataService,
		AgentCircuitManager	circuitManager
	)

inlineprotectedvirtual

Implements OpenSim.RegionApplicationBase.

Definition at line 773 of file OpenSimBase.cs.

Here is the caller graph for this function:

void OpenSim.OpenSimBase.GetAvatarNumber ( out int usernum )

inline

Get the number of the avatars in the Region server

Parameters

usernum The first out parameter describing the number of all the avatars in the Region server

Definition at line 919 of file OpenSimBase.cs.

override List<string> OpenSim.OpenSimBase.GetHelpTopics ( )

inlineprotectedvirtual

Provides a list of help topics that are available. Overriding classes should append their topics to the information returned when the base method is called.

Returns: A list of strings that represent different help topics on which more information is available

Reimplemented from OpenSim.Framework.Servers.BaseOpenSimServer.

Definition at line 202 of file OpenSimBase.cs.

Here is the caller graph for this function:

void OpenSim.OpenSimBase.GetRegionNumber ( out int regionnum )

inline

Get the number of regions

Parameters

regionnum The first out parameter describing the number of regions

Definition at line 928 of file OpenSimBase.cs.

void OpenSim.OpenSimBase.GetRunTime	(	out string	starttime,
		out string	uptime
	)

inline

Get the start time and up time of Region server

Parameters

starttime	The first out parameter describing when the Region server started
uptime	The second out parameter describing how long the Region server has run

Definition at line 909 of file OpenSimBase.cs.

virtual void OpenSim.OpenSimBase.HandleRestartRegion ( RegionInfo whichRegion )

inlineprotectedvirtual

Reimplemented in OpenSim.OpenSim.

Definition at line 782 of file OpenSimBase.cs.

Here is the call graph for this function:

Here is the caller graph for this function:

override void OpenSim.OpenSimBase.Initialize ( )

inlineprotectedvirtual

Implements OpenSim.RegionApplicationBase.

Definition at line 339 of file OpenSimBase.cs.

Here is the call graph for this function:

virtual void OpenSim.OpenSimBase.LoadConfigSettings ( IConfigSource configSource )

inlineprotectedvirtual

Definition at line 152 of file OpenSimBase.cs.

Here is the call graph for this function:

Here is the caller graph for this function:

virtual void OpenSim.OpenSimBase.LoadPlugins ( )

inlineprotectedvirtual

Definition at line 176 of file OpenSimBase.cs.

Here is the caller graph for this function:

bool OpenSim.OpenSimBase.PopulateRegionEstateInfo ( RegionInfo regInfo )

inline

Load the estate information for the provided RegionInfo object.

Parameters

regInfo

Definition at line 976 of file OpenSimBase.cs.

Here is the call graph for this function:

virtual void OpenSim.OpenSimBase.ReadExtraConfigSettings ( )

inlineprotectedvirtual

Reimplemented in OpenSim.OpenSim.

Definition at line 160 of file OpenSimBase.cs.

Here is the caller graph for this function:

void OpenSim.OpenSimBase.RemoveRegion	(	Scene	scene,
		bool	cleanup
	)

inline

Definition at line 654 of file OpenSimBase.cs.

Here is the caller graph for this function:

void OpenSim.OpenSimBase.RemoveRegion	(	string	name,
		bool	cleanUp
	)

inline

Definition at line 704 of file OpenSimBase.cs.

Here is the call graph for this function:

Scene OpenSim.OpenSimBase.SetupScene ( RegionInfo regionInfo )

inlineprotected

Create a scene and its initial base structures.

Parameters

regionInfo
clientServer

Returns

Definition at line 748 of file OpenSimBase.cs.

Here is the caller graph for this function:

Scene OpenSim.OpenSimBase.SetupScene	(	RegionInfo	regionInfo,
		int	proxyOffset,
		IConfigSource	configSource
	)

inlineprotected

Create a scene and its initial base structures.

Parameters

regionInfo
proxyOffset
configSource
clientServer

Returns

Definition at line 761 of file OpenSimBase.cs.

Here is the call graph for this function:

override void OpenSim.OpenSimBase.ShutdownSpecific ( )

inlineprotectedvirtual

Performs any last-minute sanity checking and shuts down the region server

Reimplemented from OpenSim.Framework.Servers.BaseOpenSimServer.

Definition at line 877 of file OpenSimBase.cs.

override void OpenSim.OpenSimBase.StartupSpecific ( )

inlineprotectedvirtual

Performs startup specific to the region server, including initialization of the scene such as loading configuration from disk.

Reimplemented from OpenSim.Framework.Servers.BaseOpenSimServer.

Definition at line 216 of file OpenSimBase.cs.

Here is the call graph for this function:

Member Data Documentation

ConsoleCommand OpenSim.OpenSimBase.CreateAccount = null

Definition at line 109 of file OpenSimBase.cs.

const string OpenSim.OpenSimBase.DEFAULT_PRIM_BACKUP_FILENAME = "prim-backup.xml"

protected

The file used to load and save prim backup xml if no filename has been specified

Definition at line 97 of file OpenSimBase.cs.

const string OpenSim.OpenSimBase.ESTATE_SECTION_NAME = "Estates"

Definition at line 70 of file OpenSimBase.cs.

IRegistryCore OpenSim.OpenSimBase.m_applicationRegistry = new RegistryCore()

protected

Definition at line 134 of file OpenSimBase.cs.

bool OpenSim.OpenSimBase.m_autoCreateClientStack = true

protected

Definition at line 92 of file OpenSimBase.cs.

ConfigurationLoader OpenSim.OpenSimBase.m_configLoader

protected

Definition at line 107 of file OpenSimBase.cs.

ConfigSettings OpenSim.OpenSimBase.m_configSettings

protected

Definition at line 105 of file OpenSimBase.cs.

EnvConfigSource OpenSim.OpenSimBase.m_EnvConfigSource = new EnvConfigSource()

protected

Definition at line 122 of file OpenSimBase.cs.

List<IApplicationPlugin> OpenSim.OpenSimBase.m_plugins = new List<IApplicationPlugin>()

Definition at line 111 of file OpenSimBase.cs.

string OpenSim.OpenSimBase.managedStatsURI = String.Empty

Definition at line 90 of file OpenSimBase.cs.

int OpenSim.OpenSimBase.proxyOffset = 0

protected

Definition at line 87 of file OpenSimBase.cs.

string OpenSim.OpenSimBase.proxyUrl

protected

Definition at line 86 of file OpenSimBase.cs.

string OpenSim.OpenSimBase.userStatsURI = String.Empty

Definition at line 89 of file OpenSimBase.cs.

Property Documentation

IRegistryCore OpenSim.OpenSimBase.ApplicationRegistry

get

Definition at line 137 of file OpenSimBase.cs.

OpenSimConfigSource OpenSim.OpenSimBase.ConfigSource

getset

The config information passed into the OpenSimulator region server.

Definition at line 120 of file OpenSimBase.cs.

ConfigSettings OpenSim.OpenSimBase.ConfigurationSettings

getset

Definition at line 100 of file OpenSimBase.cs.

bool OpenSim.OpenSimBase.EnableInitialPluginLoad

getset

Allow all plugin loading to be disabled for tests/debug.

true by default

Definition at line 78 of file OpenSimBase.cs.

EnvConfigSource OpenSim.OpenSimBase.envConfigSource

get

Definition at line 125 of file OpenSimBase.cs.

uint OpenSim.OpenSimBase.HttpServerPort

get

Definition at line 130 of file OpenSimBase.cs.

bool OpenSim.OpenSimBase.LoadEstateDataService

getset

Control whether we attempt to load an estate data service.

For tests/debugging

Definition at line 84 of file OpenSimBase.cs.

The documentation for this class was generated from the following file:

Region/Application/OpenSimBase.cs

Classes

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation