OpenSim
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Static Public Member Functions | Static Public Attributes | Properties | List of all members
OpenSim.Region.CoreModules.Scripting.HttpRequest.HttpRequestModule Class Reference
Inheritance diagram for OpenSim.Region.CoreModules.Scripting.HttpRequest.HttpRequestModule:
Inheritance graph
[legend]
Collaboration diagram for OpenSim.Region.CoreModules.Scripting.HttpRequest.HttpRequestModule:
Collaboration graph
[legend]

Public Member Functions

 HttpRequestModule ()
 
UUID MakeHttpRequest (string url, string parameters, string body)
 
UUID StartHttpRequest (uint localID, UUID itemID, string url, List< string > parameters, Dictionary< string, string > headers, string body, out HttpInitialRequestStatus status)
 Starts the http request. More...
 
bool CheckAllowed (Uri url)
 Would a caller to this module be allowed to make a request to the given URL? More...
 
bool StartHttpRequest (HttpRequestClass req)
 
void StopHttpRequest (uint m_localID, UUID m_itemID)
 Stop and remove all http requests for the given script. More...
 
IServiceRequest GetNextCompletedRequest ()
 
void RemoveCompletedRequest (UUID id)
 
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 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 PostInitialise ()
 This is called exactly once after all the shared region-modules have been instanciated and IRegionModuleBase.Initialised. 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 Close ()
 This is the inverse to Initialise. After a Close(), this instance won't be usable anymore. More...
 

Static Public Member Functions

static bool ValidateServerCertificate (object sender, X509Certificate certificate, X509Chain chain, SslPolicyErrors sslPolicyErrors)
 

Static Public Attributes

static SmartThreadPool ThreadPool = null
 

Properties

string Name [get]
 
Type ReplaceableInterface [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...
 

Detailed Description

Definition at line 93 of file ScriptsHttpRequests.cs.

Constructor & Destructor Documentation

OpenSim.Region.CoreModules.Scripting.HttpRequest.HttpRequestModule.HttpRequestModule ( )
inline

Definition at line 111 of file ScriptsHttpRequests.cs.

Member Function Documentation

void OpenSim.Region.CoreModules.Scripting.HttpRequest.HttpRequestModule.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 398 of file ScriptsHttpRequests.cs.

bool OpenSim.Region.CoreModules.Scripting.HttpRequest.HttpRequestModule.CheckAllowed ( Uri  url)
inline

Would a caller to this module be allowed to make a request to the given URL?

Returns

Definition at line 280 of file ScriptsHttpRequests.cs.

void OpenSim.Region.CoreModules.Scripting.HttpRequest.HttpRequestModule.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 420 of file ScriptsHttpRequests.cs.

IServiceRequest OpenSim.Region.CoreModules.Scripting.HttpRequest.HttpRequestModule.GetNextCompletedRequest ( )
inline
void OpenSim.Region.CoreModules.Scripting.HttpRequest.HttpRequestModule.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 363 of file ScriptsHttpRequests.cs.

UUID OpenSim.Region.CoreModules.Scripting.HttpRequest.HttpRequestModule.MakeHttpRequest ( string  url,
string  parameters,
string  body 
)
inline
void OpenSim.Region.CoreModules.Scripting.HttpRequest.HttpRequestModule.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 412 of file ScriptsHttpRequests.cs.

void OpenSim.Region.CoreModules.Scripting.HttpRequest.HttpRequestModule.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 416 of file ScriptsHttpRequests.cs.

void OpenSim.Region.CoreModules.Scripting.HttpRequest.HttpRequestModule.RemoveCompletedRequest ( UUID  id)
inline
void OpenSim.Region.CoreModules.Scripting.HttpRequest.HttpRequestModule.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 405 of file ScriptsHttpRequests.cs.

UUID OpenSim.Region.CoreModules.Scripting.HttpRequest.HttpRequestModule.StartHttpRequest ( uint  localID,
UUID  itemID,
string  url,
List< string >  parameters,
Dictionary< string, string >  headers,
string  body,
out HttpInitialRequestStatus  status 
)
inline

Starts the http request.

This is carried out asynchronously unless it fails initial checks. Results are fetched by the script engine HTTP requests module to be distributed back to scripts via a script event.

Returns
The ID of the request. If the requested could not be performed then this is UUID.Zero
Parameters
localIDLocal ID of the object containing the script making the request.
itemIDItem ID of the script making the request.
urlUrl to request.
parametersLSL parameters for the request.
headersExtra headers for the request.
bodyBody of the request.
statusInitial status of the request. If OK then the request is actually made to the URL. Subsequent status is then returned via IServiceRequest when the response is asynchronously fetched.

Implements OpenSim.Region.Framework.Interfaces.IHttpRequestModule.

Definition at line 163 of file ScriptsHttpRequests.cs.

bool OpenSim.Region.CoreModules.Scripting.HttpRequest.HttpRequestModule.StartHttpRequest ( HttpRequestClass  req)
inline

Definition at line 285 of file ScriptsHttpRequests.cs.

void OpenSim.Region.CoreModules.Scripting.HttpRequest.HttpRequestModule.StopHttpRequest ( uint  m_localID,
UUID  m_itemID 
)
inline

Stop and remove all http requests for the given script.

Parameters
id

Implements OpenSim.Region.Framework.Interfaces.IHttpRequestModule.

Definition at line 300 of file ScriptsHttpRequests.cs.

static bool OpenSim.Region.CoreModules.Scripting.HttpRequest.HttpRequestModule.ValidateServerCertificate ( object  sender,
X509Certificate  certificate,
X509Chain  chain,
SslPolicyErrors  sslPolicyErrors 
)
inlinestatic

Definition at line 116 of file ScriptsHttpRequests.cs.

Member Data Documentation

SmartThreadPool OpenSim.Region.CoreModules.Scripting.HttpRequest.HttpRequestModule.ThreadPool = null
static

Definition at line 109 of file ScriptsHttpRequests.cs.

Property Documentation

string OpenSim.Region.CoreModules.Scripting.HttpRequest.HttpRequestModule.Name
get

Definition at line 425 of file ScriptsHttpRequests.cs.

Type OpenSim.Region.CoreModules.Scripting.HttpRequest.HttpRequestModule.ReplaceableInterface
get

Definition at line 430 of file ScriptsHttpRequests.cs.


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