Interactive OpenSim region server More...

Inheritance diagram for OpenSim.OpenSim:

Collaboration diagram for OpenSim.OpenSim:

Public Member Functions
	OpenSim (IConfigSource configSource)

void	RunCommand (string module, string[] cmdparams)
	Runs commands issued by the server console from the operator More...

override void	HandleShow (string mod, string[] cmd)
	Many commands list objects for debugging. Some of the types are listed here More...

Public Member Functions inherited from OpenSim.OpenSimBase
	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)

string	GetVersionText ()

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

virtual void	Shutdown ()

Protected Member Functions
override void	ReadExtraConfigSettings ()

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

override void	ShutdownSpecific ()
	Should be overriden and referenced by descendents if they need to perform extra shutdown processing More...

void	ChangeSelectedRegion (string module, string[] cmdparams)
	Change the currently selected region. The selected region is that operated upon by single region commands. More...

override void	HandleRestartRegion (RegionInfo whichRegion)

void	SavePrimsXml2 (string module, string[] cmdparams)
	Use XML2 format to serialize data to a file More...

void	SaveXml (string module, string[] cmdparams)
	Use XML format to serialize data to a file More...

void	LoadXml (string module, string[] cmdparams)
	Loads data and region objects from XML format. More...

void	SaveXml2 (string module, string[] cmdparams)
	Serialize region data to XML2Format More...

void	LoadXml2 (string module, string[] cmdparams)
	Load region data from Xml2Format More...

void	LoadOar (string module, string[] cmdparams)
	Load a whole region from an opensimulator archive. More...

void	SaveOar (string module, string[] cmdparams)
	Save a region to a file, including all the assets needed to restore it. More...

void	CreateEstateCommand (string module, string[] args)

void	SetEstateOwnerCommand (string module, string[] args)

void	SetEstateNameCommand (string module, string[] args)

Protected Member Functions inherited from OpenSim.OpenSimBase
virtual void	LoadConfigSettings (IConfigSource configSource)

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)

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	m_startupCommandsFile

string	m_shutdownCommandsFile

bool	m_gui = false

string	m_consoleType = "local"

uint	m_consolePort = 0

Protected Attributes inherited from OpenSim.OpenSimBase
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...

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

Public Attributes inherited from OpenSim.OpenSimBase
const string	ESTATE_SECTION_NAME = "Estates"

string	userStatsURI = String.Empty

string	managedStatsURI = String.Empty

ConsoleCommand	CreateAccount = null

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

Properties inherited from OpenSim.OpenSimBase
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]`

Detailed Description

Interactive OpenSim region server

Definition at line 55 of file OpenSim.cs.

Constructor & Destructor Documentation

OpenSim.OpenSim.OpenSim ( IConfigSource configSource )

inline

Definition at line 79 of file OpenSim.cs.

Member Function Documentation

void OpenSim.OpenSim.ChangeSelectedRegion	(	string	module,
		string[]	cmdparams
	)

inlineprotected

Change the currently selected region. The selected region is that operated upon by single region commands.

Parameters

cmdParams

Definition at line 802 of file OpenSim.cs.

Here is the call graph for this function:

void OpenSim.OpenSim.CreateEstateCommand	(	string	module,
		string[]	args
	)

inlineprotected

Definition at line 1220 of file OpenSim.cs.

override void OpenSim.OpenSim.HandleRestartRegion ( RegionInfo whichRegion )

inlineprotectedvirtual

Reimplemented from OpenSim.OpenSimBase.

Definition at line 845 of file OpenSim.cs.

Here is the call graph for this function:

override void OpenSim.OpenSim.HandleShow	(	string	mod,
		string[]	cmd
	)

inlinevirtual

Many commands list objects for debugging. Some of the types are listed here

Parameters

mod
cmd

Reimplemented from OpenSim.Framework.Servers.ServerBase.

Definition at line 863 of file OpenSim.cs.

Here is the call graph for this function:

void OpenSim.OpenSim.LoadOar	(	string	module,
		string[]	cmdparams
	)

inlineprotected

Load a whole region from an opensimulator archive.

Parameters

cmdparams

Definition at line 1199 of file OpenSim.cs.

void OpenSim.OpenSim.LoadXml	(	string	module,
		string[]	cmdparams
	)

inlineprotected

Loads data and region objects from XML format.

Parameters

module
cmdparams

Definition at line 1105 of file OpenSim.cs.

void OpenSim.OpenSim.LoadXml2	(	string	module,
		string[]	cmdparams
	)

inlineprotected

Load region data from Xml2Format

Parameters

module
cmdparams

Definition at line 1169 of file OpenSim.cs.

override void OpenSim.OpenSim.ReadExtraConfigSettings ( )

inlineprotectedvirtual

Reimplemented from OpenSim.OpenSimBase.

Definition at line 83 of file OpenSim.cs.

void OpenSim.OpenSim.RunCommand	(	string	module,
		string[]	cmdparams
	)

inline

Runs commands issued by the server console from the operator

Parameters

command	The first argument of the parameter (the command)
cmdparams	Additional arguments passed to the command

Definition at line 754 of file OpenSim.cs.

Here is the call graph for this function:

void OpenSim.OpenSim.SaveOar	(	string	module,
		string[]	cmdparams
	)

inlineprotected

Save a region to a file, including all the assets needed to restore it.

Parameters

cmdparams

Definition at line 1215 of file OpenSim.cs.

void OpenSim.OpenSim.SavePrimsXml2	(	string	module,
		string[]	cmdparams
	)

inlineprotected

Use XML2 format to serialize data to a file

Parameters

module
cmdparams

Definition at line 1069 of file OpenSim.cs.

void OpenSim.OpenSim.SaveXml	(	string	module,
		string[]	cmdparams
	)

inlineprotected

Use XML format to serialize data to a file

Parameters

module
cmdparams

Definition at line 1086 of file OpenSim.cs.

void OpenSim.OpenSim.SaveXml2	(	string	module,
		string[]	cmdparams
	)

inlineprotected

Serialize region data to XML2Format

Parameters

module
cmdparams

Definition at line 1152 of file OpenSim.cs.

void OpenSim.OpenSim.SetEstateNameCommand	(	string	module,
		string[]	args
	)

inlineprotected

Definition at line 1345 of file OpenSim.cs.

void OpenSim.OpenSim.SetEstateOwnerCommand	(	string	module,
		string[]	args
	)

inlineprotected

Definition at line 1272 of file OpenSim.cs.

override void OpenSim.OpenSim.ShutdownSpecific ( )

inlineprotectedvirtual

Should be overriden and referenced by descendents if they need to perform extra shutdown processing

Reimplemented from OpenSim.Framework.Servers.BaseOpenSimServer.

Definition at line 438 of file OpenSim.cs.

override void OpenSim.OpenSim.StartupSpecific ( )

inlineprotectedvirtual

Performs initialisation of the scene, such as loading configuration from disk.

Reimplemented from OpenSim.Framework.Servers.BaseOpenSimServer.

Definition at line 131 of file OpenSim.cs.

Member Data Documentation

uint OpenSim.OpenSim.m_consolePort = 0

protected

Definition at line 63 of file OpenSim.cs.

string OpenSim.OpenSim.m_consoleType = "local"

protected

Definition at line 62 of file OpenSim.cs.

bool OpenSim.OpenSim.m_gui = false

protected

Definition at line 61 of file OpenSim.cs.

string OpenSim.OpenSim.m_shutdownCommandsFile

protected

Definition at line 60 of file OpenSim.cs.

string OpenSim.OpenSim.m_startupCommandsFile

protected

Definition at line 59 of file OpenSim.cs.

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

Region/Application/OpenSim.cs

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation