Common base for the main OpenSimServers (user, grid, inventory, region, etc) More...

Inheritance diagram for OpenSim.Framework.Servers.BaseOpenSimServer:

Collaboration diagram for OpenSim.Framework.Servers.BaseOpenSimServer:

Public Member Functions
	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 ()

Protected Member Functions
virtual void	StartupSpecific ()
	Must be overriden by child classes for their own server specific startup behaviour. More...

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

virtual 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...

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_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	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 base for the main OpenSimServers (user, grid, inventory, region, etc)

Definition at line 55 of file BaseOpenSimServer.cs.

Constructor & Destructor Documentation

OpenSim.Framework.Servers.BaseOpenSimServer.BaseOpenSimServer ( )

inline

Definition at line 83 of file BaseOpenSimServer.cs.

Member Function Documentation

virtual List<string> OpenSim.Framework.Servers.BaseOpenSimServer.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 in OpenSim.OpenSimBase.

Definition at line 129 of file BaseOpenSimServer.cs.

void OpenSim.Framework.Servers.BaseOpenSimServer.LogDiagnostics	(	object	source,
		ElapsedEventArgs	e
	)

inlineprotected

Print statistics to the logfile, if they are active

Definition at line 134 of file BaseOpenSimServer.cs.

override void OpenSim.Framework.Servers.BaseOpenSimServer.ShutdownSpecific ( )

inlineprotectedvirtual

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

Reimplemented from OpenSim.Framework.Servers.ServerBase.

Reimplemented in OpenSim.OpenSimBase, and OpenSim.OpenSim.

Definition at line 109 of file BaseOpenSimServer.cs.

virtual void OpenSim.Framework.Servers.BaseOpenSimServer.Startup ( )

inlinevirtual

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

Reimplemented in OpenSim.OpenSimBackground.

Definition at line 148 of file BaseOpenSimServer.cs.

virtual void OpenSim.Framework.Servers.BaseOpenSimServer.StartupSpecific ( )

inlineprotectedvirtual

Must be overriden by child classes for their own server specific startup behaviour.

Reimplemented in OpenSim.OpenSimBase, OpenSim.OpenSim, and OpenSim.RegionApplicationBase.

Definition at line 92 of file BaseOpenSimServer.cs.

string OpenSim.Framework.Servers.BaseOpenSimServer.StatReport ( IOSHttpRequest httpRequest )

inline

Definition at line 175 of file BaseOpenSimServer.cs.

Member Data Documentation

BaseHttpServer OpenSim.Framework.Servers.BaseOpenSimServer.m_httpServer

protected

Definition at line 77 of file BaseOpenSimServer.cs.

string OpenSim.Framework.Servers.BaseOpenSimServer.m_osSecret = String.Empty

protected

Random uuid for private data

Definition at line 75 of file BaseOpenSimServer.cs.

Property Documentation

BaseHttpServer OpenSim.Framework.Servers.BaseOpenSimServer.HttpServer

get

Definition at line 79 of file BaseOpenSimServer.cs.

string OpenSim.Framework.Servers.BaseOpenSimServer.osSecret

get

Definition at line 170 of file BaseOpenSimServer.cs.

bool OpenSim.Framework.Servers.BaseOpenSimServer.SuppressExit

getset

Used by tests to suppress Environment.Exit(0) so that post-run operations are possible.

Definition at line 62 of file BaseOpenSimServer.cs.

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

Framework/Servers/BaseOpenSimServer.cs

Public Member Functions

Protected Member Functions

Protected Attributes

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation