C# Class OpenSim.Framework.Servers.BaseOpenSimServer

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

Inheritance: OpenSim.Framework.Servers.ServerBase

Protected Properties

Property	Type	Description
m_console	CommandConsole
m_consoleAppender	OpenSimAppender
m_httpServer	BaseHttpServer
m_logFileAppender	IAppender
m_osSecret	string
m_pidFile	string
m_startupDirectory	string
m_startuptime	DateTime
m_stats	IStatsCollector
m_version	string

Public Methods

Method	Description
BaseOpenSimServer ( ) : System
HandleShow ( string module, string cmd ) : void
Shutdown ( ) : void	Should be overriden and referenced by descendents if they need to perform extra shutdown processing
ShutdownSpecific ( ) : void	Should be overriden and referenced by descendents if they need to perform extra shutdown processing
Startup ( ) : void	Performs initialisation of the scene, such as loading configuration from disk.
StatReport ( OSHttpRequest httpRequest ) : string

Protected Methods

Method	Description
CreatePIDFile ( string path ) : void
EnhanceVersionInformation ( ) : void	Enhance the version string with extra information if it's available.
GetHelpTopics ( ) : List	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.
GetThreadsReport ( ) : string	Get a report about the registered threads in this server.
GetUptimeReport ( ) : string	Return a report about the uptime of this server
LogDiagnostics ( object source, ElapsedEventArgs e ) : void	Print statistics to the logfile, if they are active
Notice ( string msg ) : void	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.
RemovePIDFile ( ) : void
ShowHelp ( string helpArgs ) : void	Show help information
StartupSpecific ( ) : void	Must be overriden by child classes for their own server specific startup behaviour.

Private Methods

Method	Description
HandleLogLevel ( string module, string cmd ) : void
HandleQuit ( string module, string args ) : void

Method Details

BaseOpenSimServer() public method

public BaseOpenSimServer ( ) : System
return	System

CreatePIDFile() protected method

protected CreatePIDFile ( string path ) : void
path	string
return	void

EnhanceVersionInformation() protected method

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

protected EnhanceVersionInformation ( ) : void
return	void

GetHelpTopics() protected method

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.

protected GetHelpTopics ( ) : List
return	List

GetThreadsReport() protected method

Get a report about the registered threads in this server.

protected GetThreadsReport ( ) : string
return	string

GetUptimeReport() protected method

Return a report about the uptime of this server

protected GetUptimeReport ( ) : string
return	string

HandleShow() public method

public HandleShow ( string module, string cmd ) : void
module	string
cmd	string
return	void

LogDiagnostics() protected method

Print statistics to the logfile, if they are active

protected LogDiagnostics ( object source, ElapsedEventArgs e ) : void
source	object
e	ElapsedEventArgs
return	void

Notice() protected method

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.

protected Notice ( string msg ) : void
msg	string
return	void

RemovePIDFile() protected method

protected RemovePIDFile ( ) : void
return	void

ShowHelp() protected method

Show help information

protected ShowHelp ( string helpArgs ) : void
helpArgs	string
return	void

Shutdown() public method

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

public Shutdown ( ) : void
return	void

ShutdownSpecific() public method

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

public ShutdownSpecific ( ) : void
return	void

Startup() public method

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

public Startup ( ) : void
return	void

StartupSpecific() protected method

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

protected StartupSpecific ( ) : void
return	void

StatReport() public method

public StatReport ( OSHttpRequest httpRequest ) : string
httpRequest	OSHttpRequest
return	string

Property Details

m_console protected property

protected CommandConsole m_console
return	CommandConsole

m_consoleAppender protected property

protected OpenSimAppender m_consoleAppender
return	OpenSimAppender

m_httpServer protected property

protected BaseHttpServer m_httpServer
return	BaseHttpServer

m_logFileAppender protected property

protected IAppender m_logFileAppender
return	IAppender

m_osSecret protected property

Random uuid for private data

protected string m_osSecret
return	string

m_pidFile protected property

protected string m_pidFile
return	string

m_startupDirectory protected property

Record the initial startup directory for info purposes

protected string m_startupDirectory
return	string

m_startuptime protected property

Time at which this server was started

protected DateTime m_startuptime
return	DateTime

m_stats protected property

Holds the non-viewer statistics collection object for this service/server

protected IStatsCollector m_stats
return	IStatsCollector

m_version protected property

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

protected string m_version
return	string