OpenSim
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Properties | List of all members
OpenSim.Region.CoreModules.Scripting.XMLRPC.XMLRPCModule Class Reference
Inheritance diagram for OpenSim.Region.CoreModules.Scripting.XMLRPC.XMLRPCModule:
Inheritance graph
[legend]
Collaboration diagram for OpenSim.Region.CoreModules.Scripting.XMLRPC.XMLRPCModule:
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...
 
bool IsEnabled ()
 
UUID OpenXMLRPCChannel (uint localID, UUID itemID, UUID channelID)
 
void DeleteChannels (UUID itemID)
 
void RemoteDataReply (string channel, string message_id, string sdata, int idata)
 
void CloseXMLRPCChannel (UUID channelKey)
 
bool hasRequests ()
 
IXmlRpcRequestInfo GetNextCompletedRequest ()
 
void RemoveCompletedRequest (UUID id)
 
UUID SendRemoteData (uint localID, UUID itemID, string channel, string dest, int idata, string sdata)
 
IServiceRequest GetNextCompletedSRDRequest ()
 
void RemoveCompletedSRDRequest (UUID id)
 
void CancelSRDRequests (UUID itemID)
 
XmlRpcResponse XmlRpcRemoteData (XmlRpcRequest request, IPEndPoint remoteClient)
 

Properties

int Port [get]
 
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...
 
- Properties inherited from OpenSim.Region.Framework.Interfaces.IXMLRPC
int Port [get]
 

Detailed Description

Definition at line 82 of file XMLRPCModule.cs.

Member Function Documentation

void OpenSim.Region.CoreModules.Scripting.XMLRPC.XMLRPCModule.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 142 of file XMLRPCModule.cs.

void OpenSim.Region.CoreModules.Scripting.XMLRPC.XMLRPCModule.CancelSRDRequests ( UUID  itemID)
inline

Implements OpenSim.Region.Framework.Interfaces.IXMLRPC.

Definition at line 415 of file XMLRPCModule.cs.

Here is the call graph for this function:

void OpenSim.Region.CoreModules.Scripting.XMLRPC.XMLRPCModule.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 171 of file XMLRPCModule.cs.

void OpenSim.Region.CoreModules.Scripting.XMLRPC.XMLRPCModule.CloseXMLRPCChannel ( UUID  channelKey)
inline

Implements OpenSim.Region.Framework.Interfaces.IXMLRPC.

Definition at line 317 of file XMLRPCModule.cs.

void OpenSim.Region.CoreModules.Scripting.XMLRPC.XMLRPCModule.DeleteChannels ( UUID  itemID)
inline

Implements OpenSim.Region.Framework.Interfaces.IXMLRPC.

Definition at line 249 of file XMLRPCModule.cs.

Here is the call graph for this function:

IXmlRpcRequestInfo OpenSim.Region.CoreModules.Scripting.XMLRPC.XMLRPCModule.GetNextCompletedRequest ( )
inline

Implements OpenSim.Region.Framework.Interfaces.IXMLRPC.

Definition at line 335 of file XMLRPCModule.cs.

IServiceRequest OpenSim.Region.CoreModules.Scripting.XMLRPC.XMLRPCModule.GetNextCompletedSRDRequest ( )
inline

Implements OpenSim.Region.Framework.Interfaces.IXMLRPC.

Definition at line 382 of file XMLRPCModule.cs.

bool OpenSim.Region.CoreModules.Scripting.XMLRPC.XMLRPCModule.hasRequests ( )
inline

Implements OpenSim.Region.Framework.Interfaces.IXMLRPC.

Definition at line 324 of file XMLRPCModule.cs.

void OpenSim.Region.CoreModules.Scripting.XMLRPC.XMLRPCModule.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 106 of file XMLRPCModule.cs.

bool OpenSim.Region.CoreModules.Scripting.XMLRPC.XMLRPCModule.IsEnabled ( )
inline

Implements OpenSim.Region.Framework.Interfaces.IXMLRPC.

Definition at line 189 of file XMLRPCModule.cs.

UUID OpenSim.Region.CoreModules.Scripting.XMLRPC.XMLRPCModule.OpenXMLRPCChannel ( uint  localID,
UUID  itemID,
UUID  channelID 
)
inline

Implements OpenSim.Region.Framework.Interfaces.IXMLRPC.

Definition at line 212 of file XMLRPCModule.cs.

Here is the call graph for this function:

void OpenSim.Region.CoreModules.Scripting.XMLRPC.XMLRPCModule.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 127 of file XMLRPCModule.cs.

void OpenSim.Region.CoreModules.Scripting.XMLRPC.XMLRPCModule.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 155 of file XMLRPCModule.cs.

void OpenSim.Region.CoreModules.Scripting.XMLRPC.XMLRPCModule.RemoteDataReply ( string  channel,
string  message_id,
string  sdata,
int  idata 
)
inline

Implements OpenSim.Region.Framework.Interfaces.IXMLRPC.

Definition at line 279 of file XMLRPCModule.cs.

Here is the call graph for this function:

void OpenSim.Region.CoreModules.Scripting.XMLRPC.XMLRPCModule.RemoveCompletedRequest ( UUID  id)
inline

Implements OpenSim.Region.Framework.Interfaces.IXMLRPC.

Definition at line 355 of file XMLRPCModule.cs.

void OpenSim.Region.CoreModules.Scripting.XMLRPC.XMLRPCModule.RemoveCompletedSRDRequest ( UUID  id)
inline

Implements OpenSim.Region.Framework.Interfaces.IXMLRPC.

Definition at line 403 of file XMLRPCModule.cs.

void OpenSim.Region.CoreModules.Scripting.XMLRPC.XMLRPCModule.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 159 of file XMLRPCModule.cs.

UUID OpenSim.Region.CoreModules.Scripting.XMLRPC.XMLRPCModule.SendRemoteData ( uint  localID,
UUID  itemID,
string  channel,
string  dest,
int  idata,
string  sdata 
)
inline

Implements OpenSim.Region.Framework.Interfaces.IXMLRPC.

Definition at line 372 of file XMLRPCModule.cs.

XmlRpcResponse OpenSim.Region.CoreModules.Scripting.XMLRPC.XMLRPCModule.XmlRpcRemoteData ( XmlRpcRequest  request,
IPEndPoint  remoteClient 
)
inline

Definition at line 432 of file XMLRPCModule.cs.

Here is the call graph for this function:

Property Documentation

string OpenSim.Region.CoreModules.Scripting.XMLRPC.XMLRPCModule.Name
get

Definition at line 176 of file XMLRPCModule.cs.

int OpenSim.Region.CoreModules.Scripting.XMLRPC.XMLRPCModule.Port
get

Definition at line 93 of file XMLRPCModule.cs.

Type OpenSim.Region.CoreModules.Scripting.XMLRPC.XMLRPCModule.ReplaceableInterface
get

Definition at line 181 of file XMLRPCModule.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