Inheritance diagram for OpenSim.Region.CoreModules.World.Region.RestartModule:

Collaboration diagram for OpenSim.Region.CoreModules.World.Region.RestartModule:

Public Member Functions
void	Initialise (IConfigSource config)
	This is called to initialize the region module. For shared modules, this is called exactly once, after creating the single (shared) instance. For non-shared modules, this is called once on each instance, after the instace for the region has been created. More...

void	AddRegion (Scene scene)
	This is called whenever a Scene is added. For shared modules, this can happen several times. For non-shared modules, this happens exactly once, after Initialise has been called. More...

void	RegionLoaded (Scene scene)
	This will be called once for every scene loaded. In a shared module this will be multiple times in one instance, while a nonshared module instance will only be called once. This method is called after AddRegion has been called in all modules for that scene, providing an opportunity to request another module's interface, or hook an event from another module. More...

void	RemoveRegion (Scene scene)
	This is called whenever a Scene is removed. For shared modules, this can happen several times. For non-shared modules, this happens exactly once, if the scene this instance is associated with is removed. More...

void	Close ()
	This is the inverse to Initialise. After a Close(), this instance won't be usable anymore. More...

void	ScheduleRestart (UUID initiator, string message, int[] alerts, bool notice)

int	DoOneNotice (bool sendOut)

void	SetTimer (int intervalSeconds)

void	DelayRestart (int seconds, string message)

void	AbortRestart (string message)

Protected Member Functions
void	CreateMarkerFile ()

Protected Attributes
Scene	m_Scene

Timer	m_CountdownTimer = null

DateTime	m_RestartBegin

List< int >	m_Alerts

string	m_Message

UUID	m_Initiator

bool	m_Notice = false

IDialogModule	m_DialogModule = null

string	m_MarkerPath = String.Empty

Properties
string	Name `[get]`

Type	ReplaceableInterface `[get]`

TimeSpan	TimeUntilRestart `[get]`

Properties inherited from OpenSim.Region.Framework.Interfaces.IRegionModuleBase
string	Name `[get]`

Type	ReplaceableInterface `[get]`
	If this returns non-null, it is the type of an interface that this module intends to register. This will cause the loader to defer loading of this module until all other modules have been loaded. If no other module has registered the interface by then, this module will be activated, else it will remain inactive, letting the other module take over. This should return non-null ONLY in modules that are intended to be easily replaceable, e.g. stub implementations that the developer expects to be replaced by third party provided modules. More...

Properties inherited from OpenSim.Region.Framework.Interfaces.IRestartModule
TimeSpan	TimeUntilRestart `[get]`

Detailed Description

Definition at line 49 of file RestartModule.cs.

Member Function Documentation

void OpenSim.Region.CoreModules.World.Region.RestartModule.AbortRestart ( string message )

inline

Implements OpenSim.Region.Framework.Interfaces.IRestartModule.

Definition at line 275 of file RestartModule.cs.

void OpenSim.Region.CoreModules.World.Region.RestartModule.AddRegion ( Scene scene )

inline

This is called whenever a Scene is added. For shared modules, this can happen several times. For non-shared modules, this happens exactly once, after Initialise has been called.

Parameters

scene A Scene

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 74 of file RestartModule.cs.

void OpenSim.Region.CoreModules.World.Region.RestartModule.Close ( )

inline

This is the inverse to Initialise. After a Close(), this instance won't be usable anymore.

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 112 of file RestartModule.cs.

void OpenSim.Region.CoreModules.World.Region.RestartModule.CreateMarkerFile ( )

inlineprotected

Definition at line 333 of file RestartModule.cs.

void OpenSim.Region.CoreModules.World.Region.RestartModule.DelayRestart	(	int	seconds,
		string	message
	)

inline

Implements OpenSim.Region.Framework.Interfaces.IRestartModule.

Definition at line 257 of file RestartModule.cs.

int OpenSim.Region.CoreModules.World.Region.RestartModule.DoOneNotice ( bool sendOut )

inline

Definition at line 166 of file RestartModule.cs.

void OpenSim.Region.CoreModules.World.Region.RestartModule.Initialise ( IConfigSource source )

inline

This is called to initialize the region module. For shared modules, this is called exactly once, after creating the single (shared) instance. For non-shared modules, this is called once on each instance, after the instace for the region has been created.

Parameters

source A IConfigSource

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 65 of file RestartModule.cs.

void OpenSim.Region.CoreModules.World.Region.RestartModule.RegionLoaded ( Scene scene )

inline

This will be called once for every scene loaded. In a shared module this will be multiple times in one instance, while a nonshared module instance will only be called once. This method is called after AddRegion has been called in all modules for that scene, providing an opportunity to request another module's interface, or hook an event from another module.

Parameters

scene A Scene

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 103 of file RestartModule.cs.

void OpenSim.Region.CoreModules.World.Region.RestartModule.RemoveRegion ( Scene scene )

inline

This is called whenever a Scene is removed. For shared modules, this can happen several times. For non-shared modules, this happens exactly once, if the scene this instance is associated with is removed.

Parameters

scene A Scene

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 108 of file RestartModule.cs.

void OpenSim.Region.CoreModules.World.Region.RestartModule.ScheduleRestart	(	UUID	initiator,
		string	message,
		int[]	alerts,
		bool	notice
	)

inline

Implements OpenSim.Region.Framework.Interfaces.IRestartModule.

Definition at line 131 of file RestartModule.cs.

void OpenSim.Region.CoreModules.World.Region.RestartModule.SetTimer ( int intervalSeconds )

inline

Definition at line 227 of file RestartModule.cs.

Member Data Documentation

List<int> OpenSim.Region.CoreModules.World.Region.RestartModule.m_Alerts

protected

Definition at line 57 of file RestartModule.cs.

Timer OpenSim.Region.CoreModules.World.Region.RestartModule.m_CountdownTimer = null

protected

Definition at line 55 of file RestartModule.cs.

IDialogModule OpenSim.Region.CoreModules.World.Region.RestartModule.m_DialogModule = null

protected

Definition at line 61 of file RestartModule.cs.

UUID OpenSim.Region.CoreModules.World.Region.RestartModule.m_Initiator

protected

Definition at line 59 of file RestartModule.cs.

string OpenSim.Region.CoreModules.World.Region.RestartModule.m_MarkerPath = String.Empty

protected

Definition at line 62 of file RestartModule.cs.

string OpenSim.Region.CoreModules.World.Region.RestartModule.m_Message

protected

Definition at line 58 of file RestartModule.cs.

bool OpenSim.Region.CoreModules.World.Region.RestartModule.m_Notice = false

protected

Definition at line 60 of file RestartModule.cs.

DateTime OpenSim.Region.CoreModules.World.Region.RestartModule.m_RestartBegin

protected

Definition at line 56 of file RestartModule.cs.

Scene OpenSim.Region.CoreModules.World.Region.RestartModule.m_Scene

protected

Definition at line 54 of file RestartModule.cs.

Property Documentation

string OpenSim.Region.CoreModules.World.Region.RestartModule.Name

get

Definition at line 117 of file RestartModule.cs.

Type OpenSim.Region.CoreModules.World.Region.RestartModule.ReplaceableInterface

get

Definition at line 122 of file RestartModule.cs.

TimeSpan OpenSim.Region.CoreModules.World.Region.RestartModule.TimeUntilRestart

get

Definition at line 127 of file RestartModule.cs.

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

Region/CoreModules/World/Region/RestartModule.cs

Public Member Functions

Protected Member Functions

Protected Attributes

Properties

Detailed Description

Member Function Documentation

Member Data Documentation

Property Documentation