Inheritance diagram for OpenSim.Region.CoreModules.Agent.Xfer.XferModule:

Collaboration diagram for OpenSim.Region.CoreModules.Agent.Xfer.XferModule:

Classes
class	XferDownLoad

struct	XferRequest

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	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	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...

bool	AddNewFile (string fileName, byte[] data)
	Let the Xfer module know about a file that the client is about to request. Caller is responsible for making sure that the file is here before the client starts the XferRequest. More...

void	NewClient (IClientAPI client)

void	RequestXfer (IClientAPI remoteClient, ulong xferID, string fileName)

void	AckPacket (IClientAPI remoteClient, ulong xferID, uint packet)

void	AbortXfer (IClientAPI remoteClient, ulong xferID)

Properties
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...

Detailed Description

Definition at line 43 of file XferModule.cs.

Member Function Documentation

void OpenSim.Region.CoreModules.Agent.Xfer.XferModule.AbortXfer	(	IClientAPI	remoteClient,
		ulong	xferID
	)

inline

Definition at line 212 of file XferModule.cs.

void OpenSim.Region.CoreModules.Agent.Xfer.XferModule.AckPacket	(	IClientAPI	remoteClient,
		ulong	xferID,
		uint	packet
	)

inline

Definition at line 182 of file XferModule.cs.

bool OpenSim.Region.CoreModules.Agent.Xfer.XferModule.AddNewFile	(	string	fileName,
		byte[]	data
	)

inline

Let the Xfer module know about a file that the client is about to request. Caller is responsible for making sure that the file is here before the client starts the XferRequest.

Parameters

fileName
data

Returns

Implements OpenSim.Region.Framework.Interfaces.IXfer.

Definition at line 117 of file XferModule.cs.

void OpenSim.Region.CoreModules.Agent.Xfer.XferModule.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 71 of file XferModule.cs.

void OpenSim.Region.CoreModules.Agent.Xfer.XferModule.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 96 of file XferModule.cs.

void OpenSim.Region.CoreModules.Agent.Xfer.XferModule.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 67 of file XferModule.cs.

void OpenSim.Region.CoreModules.Agent.Xfer.XferModule.NewClient ( IClientAPI client )

inline

Definition at line 140 of file XferModule.cs.

Here is the call graph for this function:

void OpenSim.Region.CoreModules.Agent.Xfer.XferModule.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 87 of file XferModule.cs.

void OpenSim.Region.CoreModules.Agent.Xfer.XferModule.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 79 of file XferModule.cs.

void OpenSim.Region.CoreModules.Agent.Xfer.XferModule.RequestXfer	(	IClientAPI	remoteClient,
		ulong	xferID,
		string	fileName
	)

inline

Parameters

remoteClient
xferID
fileName

Definition at line 153 of file XferModule.cs.

Here is the call graph for this function:

Property Documentation

string OpenSim.Region.CoreModules.Agent.Xfer.XferModule.Name

get

Definition at line 101 of file XferModule.cs.

Type OpenSim.Region.CoreModules.Agent.Xfer.XferModule.ReplaceableInterface

get

Definition at line 92 of file XferModule.cs.

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

Region/CoreModules/Agent/Xfer/XferModule.cs

Classes

Public Member Functions

Properties

Detailed Description

Member Function Documentation

Property Documentation