OpenSim::OpenSimBase Class Reference

Common OpenSim region service code. More...

Inheritance diagram for OpenSim::OpenSimBase:

OpenSim::Region::ClientStack::RegionApplicationBase OpenSim::Framework::Servers::BaseOpenSimServer OpenSim::OpenSim OpenSim::OpenSimBackground OpenSim::HGOpenSimNode List of all members.

Public Member Functions

 OpenSimBase (IConfigSource configSource)
 Constructor.
void ProcessLogin (bool LoginEnabled)
IClientNetworkServer CreateRegion (RegionInfo regionInfo, bool portadd_flag)
 Execute the region creation process. This includes setting up scene infrastructure.
IClientNetworkServer CreateRegion (RegionInfo regionInfo)
 Execute the region creation process. This includes setting up scene infrastructure.
IClientNetworkServer CreateRegion (RegionInfo regionInfo, bool portadd_flag, bool do_post_init)
 Execute the region creation process. This includes setting up scene infrastructure.
void RemoveRegion (Scene scene, bool cleanup)
void RemoveRegion (string name, bool cleanUp)
void handleRestartRegion (RegionInfo whichRegion)
override void ShutdownSpecific ()
 Performs any last-minute sanity checking and shuts down the region server.
void GetRunTime (out string starttime, out string uptime)
 Get the start time and up time of Region server.
void GetAvatarNumber (out int usernum)
 Get the number of the avatars in the Region server.
void GetRegionNumber (out int regionnum)
 Get the number of regions.

Public Attributes

ConsoleCommand CreateAccount = null

Protected Member Functions

virtual void LoadConfigSettings (IConfigSource configSource)
virtual void ReadExtraConfigSettings ()
virtual void LoadPlugins ()
override void StartupSpecific ()
 Performs startup specific to this region server, including initialization of the scene such as loading configuration from disk.
virtual void InitialiseStandaloneServices (LibraryRootFolder libraryRootFolder)
 Initialises the backend services for standalone mode, and registers some http handlers.
virtual void InitialiseGridServices (LibraryRootFolder libraryRootFolder)
override void Initialize ()
virtual void InitialiseAssetCache ()
 Initialises the assetcache.
override StorageManager CreateStorageManager ()
StorageManager CreateStorageManager (string connectionstring, string estateconnectionstring)
override ClientStackManager CreateClientStackManager ()
override Scene CreateScene (RegionInfo regionInfo, StorageManager storageManager, AgentCircuitManager circuitManager)
override PhysicsScene GetPhysicsScene (string osSceneIdentifier)
 Get a new physics scene.

Protected Attributes

string proxyUrl
int proxyOffset = 0
const string DEFAULT_PRIM_BACKUP_FILENAME = "prim-backup.xml"
 The file used to load and save prim backup xml if no filename has been specified.
const string DEFAULT_OAR_BACKUP_FILENAME = "scene_oar.tar.gz"
 The file used to load and save an opensim archive if no filename has been specified.
const string DEFAULT_INV_BACKUP_FILENAME = "opensim_inv.tar.gz"
 The file to load and save inventory if no filename has been specified.
ConfigSettings m_configSettings
ConfigurationLoader m_configLoader
GridInfoService m_gridInfoService
List< IClientNetworkServerm_clientServers = new List<IClientNetworkServer>()
List< RegionInfom_regionData = new List<RegionInfo>()
List< IApplicationPluginm_plugins = new List<IApplicationPlugin>()
OpenSimConfigSource m_config
ModuleLoader m_moduleLoader

Properties

ConfigSettings ConfigurationSettings [get, set]
OpenSimConfigSource ConfigSource [get, set]
List< IClientNetworkServerClientServers [get]
List< RegionInfoRegionData [get]
new BaseHttpServer HttpServer [get]
uint HttpServerPort [get]
ModuleLoader ModuleLoader [get, set]

Classes

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

Detailed Description

Common OpenSim region service code.


Constructor & Destructor Documentation

OpenSim::OpenSimBase::OpenSimBase ( IConfigSource  configSource  )  [inline]

Constructor.

Parameters:
configSource 


Member Function Documentation

virtual void OpenSim::OpenSimBase::LoadConfigSettings ( IConfigSource  configSource  )  [inline, protected, virtual]

virtual void OpenSim::OpenSimBase::ReadExtraConfigSettings (  )  [inline, protected, virtual]

Reimplemented in OpenSim::OpenSim.

virtual void OpenSim::OpenSimBase::LoadPlugins (  )  [inline, protected, virtual]

override void OpenSim::OpenSimBase::StartupSpecific (  )  [inline, protected, virtual]

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

Reimplemented from OpenSim::Region::ClientStack::RegionApplicationBase.

Reimplemented in OpenSim::HGOpenSimNode, and OpenSim::OpenSim.

virtual void OpenSim::OpenSimBase::InitialiseStandaloneServices ( LibraryRootFolder  libraryRootFolder  )  [inline, protected, virtual]

Initialises the backend services for standalone mode, and registers some http handlers.

Parameters:
libraryRootFolder 

Reimplemented in OpenSim::HGOpenSimNode.

virtual void OpenSim::OpenSimBase::InitialiseGridServices ( LibraryRootFolder  libraryRootFolder  )  [inline, protected, virtual]

Reimplemented in OpenSim::HGOpenSimNode.

override void OpenSim::OpenSimBase::Initialize (  )  [inline, protected, virtual]

Implements OpenSim::Region::ClientStack::RegionApplicationBase.

virtual void OpenSim::OpenSimBase::InitialiseAssetCache (  )  [inline, protected, virtual]

Initialises the assetcache.

void OpenSim::OpenSimBase::ProcessLogin ( bool  LoginEnabled  )  [inline]

IClientNetworkServer OpenSim::OpenSimBase::CreateRegion ( RegionInfo  regionInfo,
bool  portadd_flag 
) [inline]

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

Parameters:
regionInfo 
portadd_flag 
Returns:

IClientNetworkServer OpenSim::OpenSimBase::CreateRegion ( RegionInfo  regionInfo  )  [inline]

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

Parameters:
regionInfo 
Returns:

IClientNetworkServer OpenSim::OpenSimBase::CreateRegion ( RegionInfo  regionInfo,
bool  portadd_flag,
bool  do_post_init 
) [inline]

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

Parameters:
regionInfo 
portadd_flag 
do_post_init 
Returns:

void OpenSim::OpenSimBase::RemoveRegion ( Scene  scene,
bool  cleanup 
) [inline]

void OpenSim::OpenSimBase::RemoveRegion ( string  name,
bool  cleanUp 
) [inline]

override StorageManager OpenSim::OpenSimBase::CreateStorageManager (  )  [inline, protected, virtual]

Implements OpenSim::Region::ClientStack::RegionApplicationBase.

StorageManager OpenSim::OpenSimBase::CreateStorageManager ( string  connectionstring,
string  estateconnectionstring 
) [inline, protected]

override ClientStackManager OpenSim::OpenSimBase::CreateClientStackManager (  )  [inline, protected, virtual]

Implements OpenSim::Region::ClientStack::RegionApplicationBase.

override Scene OpenSim::OpenSimBase::CreateScene ( RegionInfo  regionInfo,
StorageManager  storageManager,
AgentCircuitManager  circuitManager 
) [inline, protected, virtual]

Implements OpenSim::Region::ClientStack::RegionApplicationBase.

Reimplemented in OpenSim::HGOpenSimNode.

void OpenSim::OpenSimBase::handleRestartRegion ( RegionInfo  whichRegion  )  [inline]

override PhysicsScene OpenSim::OpenSimBase::GetPhysicsScene ( string  osSceneIdentifier  )  [inline, protected, virtual]

Get a new physics scene.

Parameters:
osSceneIdentifier The name of the OpenSim scene this physics scene is serving. This will be used in log messages.
Returns:

Implements OpenSim::Region::ClientStack::RegionApplicationBase.

override void OpenSim::OpenSimBase::ShutdownSpecific (  )  [inline, virtual]

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

Reimplemented from OpenSim::Framework::Servers::BaseOpenSimServer.

Reimplemented in OpenSim::OpenSim.

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

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

void OpenSim::OpenSimBase::GetRegionNumber ( out int  regionnum  )  [inline]

Get the number of regions.

Parameters:
regionnum The first out parameter describing the number of regions


Member Data Documentation

string OpenSim::OpenSimBase::proxyUrl [protected]

int OpenSim::OpenSimBase::proxyOffset = 0 [protected]

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.

const string OpenSim::OpenSimBase::DEFAULT_OAR_BACKUP_FILENAME = "scene_oar.tar.gz" [protected]

The file used to load and save an opensim archive if no filename has been specified.

const string OpenSim::OpenSimBase::DEFAULT_INV_BACKUP_FILENAME = "opensim_inv.tar.gz" [protected]

The file to load and save inventory if no filename has been specified.

ConfigSettings OpenSim::OpenSimBase::m_configSettings [protected]

ConfigurationLoader OpenSim::OpenSimBase::m_configLoader [protected]

GridInfoService OpenSim::OpenSimBase::m_gridInfoService [protected]

List<IClientNetworkServer> OpenSim::OpenSimBase::m_clientServers = new List<IClientNetworkServer>() [protected]

List<RegionInfo> OpenSim::OpenSimBase::m_regionData = new List<RegionInfo>() [protected]

ConsoleCommand OpenSim::OpenSimBase::CreateAccount = null

List<IApplicationPlugin> OpenSim::OpenSimBase::m_plugins = new List<IApplicationPlugin>() [protected]

OpenSimConfigSource OpenSim::OpenSimBase::m_config [protected]

ModuleLoader OpenSim::OpenSimBase::m_moduleLoader [protected]


Property Documentation

ConfigSettings OpenSim::OpenSimBase::ConfigurationSettings [get, set]

OpenSimConfigSource OpenSim::OpenSimBase::ConfigSource [get, set]

The config information passed into the OpenSim region server.

List<IClientNetworkServer> OpenSim::OpenSimBase::ClientServers [get]

List<RegionInfo> OpenSim::OpenSimBase::RegionData [get]

new BaseHttpServer OpenSim::OpenSimBase::HttpServer [get]

Reimplemented from OpenSim::Framework::Servers::BaseOpenSimServer.

uint OpenSim::OpenSimBase::HttpServerPort [get]

ModuleLoader OpenSim::OpenSimBase::ModuleLoader [get, set]


The documentation for this class was generated from the following file:
Generated on Fri Jan 9 01:00:44 2009 for OpenSim by  doxygen 1.5.1