OpenSim::Region::CoreModules::Agent::AssetTransaction::AssetTransactionModule Class Reference

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

List of all members.

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.

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.

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.

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.

void Close ()

This is the inverse to Initialise. After a Close(), this instance won't be usable anymore.

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

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

void HandleItemUpdateFromTransaction (IClientAPI remoteClient, UUID transactionID, InventoryItemBase item)

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

void HandleTaskItemUpdateFromTransaction (IClientAPI remoteClient, SceneObjectPart part, UUID transactionID, TaskInventoryItem item)

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

void HandleUDPUploadRequest (IClientAPI remoteClient, UUID assetID, UUID transaction, sbyte type, byte[] data, bool storeLocal, bool tempFile)

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

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

Protected Attributes

Scene m_Scene

Properties

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.

Member Function Documentation

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.

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.

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.

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.

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.

void OpenSim::Region::CoreModules::Agent::AssetTransaction::AssetTransactionModule::NewClient ( IClientAPI client ) [inline]

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.

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

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.

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
	transactionID
	item

Implements OpenSim::Region::Framework::Interfaces::IAgentAssetTransactions.

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

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

Parameters:

	remoteClient
	assetID
	transaction
	type
	data

Parameters:

tempFile

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

Member Data Documentation

Scene OpenSim::Region::CoreModules::Agent::AssetTransaction::AssetTransactionModule::m_Scene [protected]

Property Documentation

string OpenSim::Region::CoreModules::Agent::AssetTransaction::AssetTransactionModule::Name [get]

The name of the module

Implements OpenSim::Region::Framework::Interfaces::IRegionModuleBase.

Type OpenSim::Region::CoreModules::Agent::AssetTransaction::AssetTransactionModule::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.

Implements OpenSim::Region::Framework::Interfaces::IRegionModuleBase.

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

/home/sdague/opensim-docsgit/opensim/OpenSim/Region/CoreModules/Agent/AssetTransaction/AssetTransactionModule.cs


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.
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.
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.
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.
void	Close ()
	This is the inverse to Initialise. After a Close(), this instance won't be usable anymore.
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).
void	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.
void	HandleItemUpdateFromTransaction (IClientAPI remoteClient, UUID transactionID, InventoryItemBase item)
	Update an inventory item with data that has been received through a transaction.
void	HandleTaskItemUpdateFromTransaction (IClientAPI remoteClient, SceneObjectPart part, UUID transactionID, TaskInventoryItem item)
	Update a task inventory item with data that has been received through a transaction.
void	HandleUDPUploadRequest (IClientAPI remoteClient, UUID assetID, UUID transaction, sbyte type, byte[] data, bool storeLocal, bool tempFile)
	Request that a client (agent) begin an asset transfer.
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().
Protected Attributes
Scene	m_Scene
Properties
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.