Inheritance diagram for OpenSim.Region.CoreModules.Agent.AssetTransaction.AssetTransactionModule:

Collaboration diagram for OpenSim.Region.CoreModules.Agent.AssetTransaction.AssetTransactionModule:

Public Member Functions
void	Initialise (IConfigSource source)
	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	NewClient (IClientAPI client)

void	RemoveAgentAssetTransactions (UUID userID)
	Remove the given agent asset transactions. This should be called when a client is departing from a scene (and hence won't be making any more transactions here). More...

bool	HandleItemCreationFromTransaction (IClientAPI remoteClient, UUID transactionID, UUID folderID, uint callbackID, string description, string name, sbyte invType, sbyte type, byte wearableType, uint nextOwnerMask)
	Create an inventory item from data that has been received through a transaction. This is called when new clothing or body parts are created. It may also be called in other situations. More...

void	HandleItemUpdateFromTransaction (IClientAPI remoteClient, UUID transactionID, InventoryItemBase item)
	Update an inventory item with data that has been received through a transaction. More...

void	HandleTaskItemUpdateFromTransaction (IClientAPI remoteClient, SceneObjectPart part, UUID transactionID, TaskInventoryItem item)
	Update a task inventory item with data that has been received through a transaction. More...

void	HandleUDPUploadRequest (IClientAPI remoteClient, UUID assetID, UUID transactionID, sbyte type, byte[] data, bool storeLocal, bool tempFile)
	Request that a client (agent) begin an asset transfer. More...

void	HandleXfer (IClientAPI remoteClient, ulong xferID, uint packetID, byte[] data)
	Handle asset transfer data packets received in response to the asset upload request in HandleUDPUploadRequest() More...

Protected Attributes
Scene	m_Scene

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 42 of file AssetTransactionModule.cs.

Member Function Documentation

void OpenSim.Region.CoreModules.Agent.AssetTransaction.AssetTransactionModule.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 68 of file AssetTransactionModule.cs.

void OpenSim.Region.CoreModules.Agent.AssetTransaction.AssetTransactionModule.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 83 of file AssetTransactionModule.cs.

bool OpenSim.Region.CoreModules.Agent.AssetTransaction.AssetTransactionModule.HandleItemCreationFromTransaction	(	IClientAPI	remoteClient,
		UUID	transactionID,
		UUID	folderID,
		uint	callbackID,
		string	description,
		string	name,
		sbyte	invType,
		sbyte	type,
		byte	wearableType,
		uint	nextOwnerMask
	)

inline

Create an inventory item from data that has been received through a transaction. This is called when new clothing or body parts are created. It may also be called in other situations.

Parameters

remoteClient
transactionID
folderID
callbackID
description
name
invType
type
wearableType
nextOwnerMask

Implements OpenSim.Region.Framework.Interfaces.IAgentAssetTransactions.

Definition at line 161 of file AssetTransactionModule.cs.

void OpenSim.Region.CoreModules.Agent.AssetTransaction.AssetTransactionModule.HandleItemUpdateFromTransaction	(	IClientAPI	remoteClient,
		UUID	transactionID,
		InventoryItemBase	item
	)

inline

Update an inventory item with data that has been received through a transaction.

This is called when clothing or body parts are updated (for instance, with new textures or colours). It may also be called in other situations.

Parameters

remoteClient
transactionID
item

Implements OpenSim.Region.Framework.Interfaces.IAgentAssetTransactions.

Definition at line 189 of file AssetTransactionModule.cs.

void OpenSim.Region.CoreModules.Agent.AssetTransaction.AssetTransactionModule.HandleTaskItemUpdateFromTransaction	(	IClientAPI	remoteClient,
		SceneObjectPart	part,
		UUID	transactionID,
		TaskInventoryItem	item
	)

inline

Update a task inventory item with data that has been received through a transaction.

This is currently called when, for instance, a notecard in a prim is saved. The data is sent up through a single AssetUploadRequest. A subsequent UpdateTaskInventory then references the transaction and comes through this method.

Parameters

remoteClient
part
transactionID
item

Implements OpenSim.Region.Framework.Interfaces.IAgentAssetTransactions.

Definition at line 214 of file AssetTransactionModule.cs.

void OpenSim.Region.CoreModules.Agent.AssetTransaction.AssetTransactionModule.HandleUDPUploadRequest	(	IClientAPI	remoteClient,
		UUID	assetID,
		UUID	transactionID,
		sbyte	type,
		byte[]	data,
		bool	storeLocal,
		bool	tempFile
	)

inline

Request that a client (agent) begin an asset transfer.

Parameters

remoteClient
assetID
transactionID
type
data

Parameters

tempFile

Definition at line 237 of file AssetTransactionModule.cs.

Here is the call graph for this function:

void OpenSim.Region.CoreModules.Agent.AssetTransaction.AssetTransactionModule.HandleXfer	(	IClientAPI	remoteClient,
		ulong	xferID,
		uint	packetID,
		byte[]	data
	)

inline

Handle asset transfer data packets received in response to the asset upload request in HandleUDPUploadRequest()

Parameters

remoteClient
xferID
packetID
data

Definition at line 291 of file AssetTransactionModule.cs.

void OpenSim.Region.CoreModules.Agent.AssetTransaction.AssetTransactionModule.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 59 of file AssetTransactionModule.cs.

void OpenSim.Region.CoreModules.Agent.AssetTransaction.AssetTransactionModule.NewClient ( IClientAPI client )

inline

Definition at line 99 of file AssetTransactionModule.cs.

void OpenSim.Region.CoreModules.Agent.AssetTransaction.AssetTransactionModule.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 75 of file AssetTransactionModule.cs.

void OpenSim.Region.CoreModules.Agent.AssetTransaction.AssetTransactionModule.RemoveAgentAssetTransactions ( UUID userID )

inline

Remove the given agent asset transactions. This should be called when a client is departing from a scene (and hence won't be making any more transactions here).

Parameters

userID

Implements OpenSim.Region.Framework.Interfaces.IAgentAssetTransactions.

Definition at line 135 of file AssetTransactionModule.cs.

void OpenSim.Region.CoreModules.Agent.AssetTransaction.AssetTransactionModule.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 AssetTransactionModule.cs.

Member Data Documentation

Scene OpenSim.Region.CoreModules.Agent.AssetTransaction.AssetTransactionModule.m_Scene

protected

Definition at line 47 of file AssetTransactionModule.cs.

Property Documentation

string OpenSim.Region.CoreModules.Agent.AssetTransaction.AssetTransactionModule.Name

get

Definition at line 88 of file AssetTransactionModule.cs.

Type OpenSim.Region.CoreModules.Agent.AssetTransaction.AssetTransactionModule.ReplaceableInterface

get

Definition at line 93 of file AssetTransactionModule.cs.

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

Region/CoreModules/Agent/AssetTransaction/AssetTransactionModule.cs

Public Member Functions

Protected Attributes

Properties

Detailed Description

Member Function Documentation

Member Data Documentation

Property Documentation