OpenSim
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Public Attributes | Properties | List of all members
OpenSim.Region.CoreModules.Scripting.LSLHttp.UrlModule Class Reference

This module provides external URLs for in-world scripts. More...

Inheritance diagram for OpenSim.Region.CoreModules.Scripting.LSLHttp.UrlModule:
Inheritance graph
[legend]
Collaboration diagram for OpenSim.Region.CoreModules.Scripting.LSLHttp.UrlModule:
Collaboration graph
[legend]

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 PostInitialise ()
 This is called exactly once after all the shared region-modules have been instanciated and IRegionModuleBase.Initialised. 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...
 
UUID RequestURL (IScriptModule engine, SceneObjectPart host, UUID itemID, Hashtable options)
 
UUID RequestSecureURL (IScriptModule engine, SceneObjectPart host, UUID itemID, Hashtable options)
 
void ReleaseURL (string url)
 
void HttpContentType (UUID request, string type)
 
void HttpResponse (UUID request, int status, string body)
 
string GetHttpHeader (UUID requestId, string header)
 
int GetFreeUrls ()
 
void ScriptRemoved (UUID itemID)
 
void ObjectRemoved (UUID objectID)
 
void HttpRequestHandler (UUID requestID, Hashtable request)
 

Public Attributes

const int DefaultTotalUrls = 15000
 The default maximum number of urls More...
 

Properties

string ExternalHostNameForLSL [get, set]
 
int TotalUrls [get, set]
 Maximum number of external urls that can be set up by this module. More...
 
Type ReplaceableInterface [get]
 
string Name [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.IUrlModule
string ExternalHostNameForLSL [get]
 

Detailed Description

This module provides external URLs for in-world scripts.

Definition at line 80 of file UrlModule.cs.

Member Function Documentation

void OpenSim.Region.CoreModules.Scripting.LSLHttp.UrlModule.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
sceneA Scene

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 147 of file UrlModule.cs.

void OpenSim.Region.CoreModules.Scripting.LSLHttp.UrlModule.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 192 of file UrlModule.cs.

int OpenSim.Region.CoreModules.Scripting.LSLHttp.UrlModule.GetFreeUrls ( )
inline

Implements OpenSim.Region.Framework.Interfaces.IUrlModule.

Definition at line 397 of file UrlModule.cs.

string OpenSim.Region.CoreModules.Scripting.LSLHttp.UrlModule.GetHttpHeader ( UUID  requestId,
string  header 
)
inline

Implements OpenSim.Region.Framework.Interfaces.IUrlModule.

Definition at line 378 of file UrlModule.cs.

void OpenSim.Region.CoreModules.Scripting.LSLHttp.UrlModule.HttpContentType ( UUID  request,
string  type 
)
inline

Implements OpenSim.Region.Framework.Interfaces.IUrlModule.

Definition at line 319 of file UrlModule.cs.

void OpenSim.Region.CoreModules.Scripting.LSLHttp.UrlModule.HttpRequestHandler ( UUID  requestID,
Hashtable  request 
)
inline

Definition at line 586 of file UrlModule.cs.

Here is the call graph for this function:

void OpenSim.Region.CoreModules.Scripting.LSLHttp.UrlModule.HttpResponse ( UUID  request,
int  status,
string  body 
)
inline

Implements OpenSim.Region.Framework.Interfaces.IUrlModule.

Definition at line 335 of file UrlModule.cs.

void OpenSim.Region.CoreModules.Scripting.LSLHttp.UrlModule.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
sourceA IConfigSource

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 118 of file UrlModule.cs.

void OpenSim.Region.CoreModules.Scripting.LSLHttp.UrlModule.ObjectRemoved ( UUID  objectID)
inline

Implements OpenSim.Region.Framework.Interfaces.IUrlModule.

Definition at line 430 of file UrlModule.cs.

void OpenSim.Region.CoreModules.Scripting.LSLHttp.UrlModule.PostInitialise ( )
inline

This is called exactly once after all the shared region-modules have been instanciated and IRegionModuleBase.Initialised.

Implements OpenSim.Region.Framework.Interfaces.ISharedRegionModule.

Definition at line 143 of file UrlModule.cs.

void OpenSim.Region.CoreModules.Scripting.LSLHttp.UrlModule.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
sceneA Scene

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 167 of file UrlModule.cs.

Here is the call graph for this function:

void OpenSim.Region.CoreModules.Scripting.LSLHttp.UrlModule.ReleaseURL ( string  url)
inline

Implements OpenSim.Region.Framework.Interfaces.IUrlModule.

Definition at line 293 of file UrlModule.cs.

void OpenSim.Region.CoreModules.Scripting.LSLHttp.UrlModule.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
sceneA Scene

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 177 of file UrlModule.cs.

UUID OpenSim.Region.CoreModules.Scripting.LSLHttp.UrlModule.RequestSecureURL ( IScriptModule  engine,
SceneObjectPart  host,
UUID  itemID,
Hashtable  options 
)
inline

Implements OpenSim.Region.Framework.Interfaces.IUrlModule.

Definition at line 242 of file UrlModule.cs.

UUID OpenSim.Region.CoreModules.Scripting.LSLHttp.UrlModule.RequestURL ( IScriptModule  engine,
SceneObjectPart  host,
UUID  itemID,
Hashtable  options 
)
inline

Implements OpenSim.Region.Framework.Interfaces.IUrlModule.

Definition at line 196 of file UrlModule.cs.

void OpenSim.Region.CoreModules.Scripting.LSLHttp.UrlModule.ScriptRemoved ( UUID  itemID)
inline

Implements OpenSim.Region.Framework.Interfaces.IUrlModule.

Definition at line 403 of file UrlModule.cs.

Member Data Documentation

const int OpenSim.Region.CoreModules.Scripting.LSLHttp.UrlModule.DefaultTotalUrls = 15000

The default maximum number of urls

Definition at line 101 of file UrlModule.cs.

Property Documentation

string OpenSim.Region.CoreModules.Scripting.LSLHttp.UrlModule.ExternalHostNameForLSL
getset

Definition at line 96 of file UrlModule.cs.

string OpenSim.Region.CoreModules.Scripting.LSLHttp.UrlModule.Name
get

Definition at line 114 of file UrlModule.cs.

Type OpenSim.Region.CoreModules.Scripting.LSLHttp.UrlModule.ReplaceableInterface
get

Definition at line 109 of file UrlModule.cs.

int OpenSim.Region.CoreModules.Scripting.LSLHttp.UrlModule.TotalUrls
getset

Maximum number of external urls that can be set up by this module.

Definition at line 106 of file UrlModule.cs.

The documentation for this class was generated from the following file:
Generated on Wed Apr 6 2016 04:35:10 for OpenSim by   doxygen 1.8.6