Inheritance diagram for OpenSim.Framework.Servers.ServerBase:

Collaboration diagram for OpenSim.Framework.Servers.ServerBase:

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

Static Public Member Functions
static string	GetThreadPoolReport ()
	Get a thread pool report. More...

Protected Member Functions
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...

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

Protected Attributes
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
IConfigSource	Config `[get, set]`

Detailed Description

Definition at line 47 of file ServerBase.cs.

Constructor & Destructor Documentation

OpenSim.Framework.Servers.ServerBase.ServerBase ( )

inline

Definition at line 73 of file ServerBase.cs.

Member Function Documentation

void OpenSim.Framework.Servers.ServerBase.CreatePIDFile ( string path )

inlineprotected

Definition at line 80 of file ServerBase.cs.

Here is the caller graph for this function:

void OpenSim.Framework.Servers.ServerBase.EnhanceVersionInformation ( )

inlineprotected

Enhance the version string with extra information if it's available.

Definition at line 781 of file ServerBase.cs.

static string OpenSim.Framework.Servers.ServerBase.GetThreadPoolReport ( )

inlinestatic

Get a thread pool report.

Returns

Definition at line 932 of file ServerBase.cs.

string OpenSim.Framework.Servers.ServerBase.GetThreadsReport ( )

inlineprotected

Get a report about the registered threads in this server.

Definition at line 883 of file ServerBase.cs.

string OpenSim.Framework.Servers.ServerBase.GetUptimeReport ( )

inlineprotected

Return a report about the uptime of this server

Returns

Definition at line 761 of file ServerBase.cs.

string OpenSim.Framework.Servers.ServerBase.GetVersionText ( )

inline

Definition at line 874 of file ServerBase.cs.

virtual void OpenSim.Framework.Servers.ServerBase.HandleScript	(	string	module,
		string[]	parms
	)

inlineprotectedvirtual

Definition at line 714 of file ServerBase.cs.

virtual void OpenSim.Framework.Servers.ServerBase.HandleShow	(	string	module,
		string[]	cmd
	)

inlinevirtual

Reimplemented in OpenSim.OpenSim.

Definition at line 543 of file ServerBase.cs.

virtual void OpenSim.Framework.Servers.ServerBase.HandleThreadsAbort	(	string	module,
		string[]	cmd
	)

inlinevirtual

Definition at line 989 of file ServerBase.cs.

Here is the call graph for this function:

void OpenSim.Framework.Servers.ServerBase.LogEnvironmentInformation ( )

inline

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

Definition at line 128 of file ServerBase.cs.

void OpenSim.Framework.Servers.ServerBase.Notice ( string msg )

inlineprotected

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.

Parameters

msg

Definition at line 1016 of file ServerBase.cs.

void OpenSim.Framework.Servers.ServerBase.Notice	(	string	format,
		params object[]	components
	)

inlineprotected

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.

Parameters

format
components

Definition at line 1031 of file ServerBase.cs.

void OpenSim.Framework.Servers.ServerBase.RegisterCommonAppenders ( IConfig startupConfig )

inline

Definition at line 144 of file ServerBase.cs.

void OpenSim.Framework.Servers.ServerBase.RegisterCommonCommands ( )

inline

Register common commands once m_console has been set if it is going to be set

Definition at line 193 of file ServerBase.cs.

void OpenSim.Framework.Servers.ServerBase.RegisterCommonComponents ( IConfigSource configSource )

inline

Definition at line 327 of file ServerBase.cs.

void OpenSim.Framework.Servers.ServerBase.RemovePIDFile ( )

inlineprotected

Definition at line 107 of file ServerBase.cs.

void OpenSim.Framework.Servers.ServerBase.RunCommandScript ( string fileName )

inlineprotected

Run an optional startup list of commands

Parameters

fileName

Definition at line 729 of file ServerBase.cs.

void OpenSim.Framework.Servers.ServerBase.ShowInfo ( )

inlineprotected

Definition at line 770 of file ServerBase.cs.

virtual void OpenSim.Framework.Servers.ServerBase.Shutdown ( )

inlinevirtual

Reimplemented in OpenSim.OpenSimBackground.

Definition at line 1037 of file ServerBase.cs.

virtual void OpenSim.Framework.Servers.ServerBase.ShutdownSpecific ( )

inlineprotectedvirtual

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

Reimplemented in OpenSim.OpenSimBase, OpenSim.OpenSim, OpenSim.Server.Base.ServicesServerBase, and OpenSim.Framework.Servers.BaseOpenSimServer.

Definition at line 1046 of file ServerBase.cs.

Member Data Documentation

ICommandConsole OpenSim.Framework.Servers.ServerBase.m_console

protected

Console to be used for any command line output. Can be null, in which case there should be no output.

Definition at line 56 of file ServerBase.cs.

OpenSimAppender OpenSim.Framework.Servers.ServerBase.m_consoleAppender

protected

Definition at line 58 of file ServerBase.cs.

FileAppender OpenSim.Framework.Servers.ServerBase.m_logFileAppender

protected

Definition at line 59 of file ServerBase.cs.

string OpenSim.Framework.Servers.ServerBase.m_pidFile = String.Empty

protected

Definition at line 64 of file ServerBase.cs.

ServerStatsCollector OpenSim.Framework.Servers.ServerBase.m_serverStatsCollector

protected

Definition at line 66 of file ServerBase.cs.

string OpenSim.Framework.Servers.ServerBase.m_startupDirectory = Environment.CurrentDirectory

protected

Definition at line 62 of file ServerBase.cs.

DateTime OpenSim.Framework.Servers.ServerBase.m_startuptime

protected

Definition at line 61 of file ServerBase.cs.

string OpenSim.Framework.Servers.ServerBase.m_version

protected

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

Definition at line 71 of file ServerBase.cs.

Property Documentation

IConfigSource OpenSim.Framework.Servers.ServerBase.Config

getset

Definition at line 51 of file ServerBase.cs.

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

Framework/Servers/ServerBase.cs

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Properties

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation