OpenSim::Framework::Communications::Capabilities::Caps

OpenSim::Framework::Communications::Capabilities::Caps Class Reference


Public Member Functions
	Caps (AssetCache assetCache, BaseHttpServer httpServer, string httpListen, uint httpPort, string capsPath, UUID agent, bool dumpAssetsToFile, string regionName)
void	RegisterHandlers ()
	Register all CAPS http service handlers.
void	RegisterHandler (string capName, IRequestHandler handler)
	Register a handler. This allows modules to register handlers.
void	DeregisterHandlers ()
	Remove all CAPS service handlers.
string	CapsRequest (string request, string path, string param, OSHttpRequest httpRequest, OSHttpResponse httpResponse)
	Construct a client response detailing all the capabilities this server can provide.
string	FetchInventoryRequest (string request, string path, string param)
	Processes a fetch inventory request and sends the reply.
LLSDMapLayerResponse	GetMapLayer (LLSDMapRequest mapReq)
string	RequestTexture (string request, string path, string param)
string	ProcessEventQueue (string request, string path, string param)
string	CreateEstablishAgentComms (string caps, string ipAddressPort)
string	CreateEmptyEventResponse ()
string	ScriptTaskInventory (string request, string path, string param, OSHttpRequest httpRequest, OSHttpResponse httpResponse)
	Called by the script task update handler. Provides a URL to which the client can upload a new asset.
string	NoteCardAgentInventory (string request, string path, string param, OSHttpRequest httpRequest, OSHttpResponse httpResponse)
	Called by the notecard update handler. Provides a URL to which the client can upload a new asset.
LLSDAssetUploadResponse	NewAgentInventoryRequest (LLSDAssetUploadRequest llsdRequest)
void	UploadCompleteHandler (string assetName, string assetDescription, UUID assetID, UUID inventoryItem, UUID parentFolder, byte[] data, string inventoryType, string assetType)
UUID	ItemUpdated (UUID itemID, byte[] data)
	Called when new asset data for an agent inventory item update has been uploaded.
void	TaskScriptUpdated (UUID itemID, UUID primID, bool isScriptRunning, byte[] data)
	Called when new asset data for an agent inventory item update has been uploaded.
Public Attributes
NewInventoryItem	AddNewInventoryItem = null
ItemUpdatedCallback	ItemUpdatedCall = null
TaskScriptUpdatedCallback	TaskScriptUpdatedCall = null
FetchInventoryDescendentsCAPS	CAPSFetchInventoryDescendents = null
GetClientDelegate	GetClient = null
Static Protected Member Functions
static OSDMapLayer	GetOSDMapLayerResponse ()
Properties
string	CapsObjectPath `[get]`
bool	SSLCaps `[get]`
string	SSLCommonName `[get]`
Classes
class	AssetUploader
class	ItemUpdater
	This class is a callback invoked when a client sends asset data to an agent inventory notecard update url. More...
class	TaskInventoryScriptUpdater
	This class is a callback invoked when a client sends asset data to a task inventory script update url. More...

Constructor & Destructor Documentation

OpenSim::Framework::Communications::Capabilities::Caps::Caps	(	AssetCache	assetCache,
		BaseHttpServer	httpServer,
		string	httpListen,
		uint	httpPort,
		string	capsPath,
		UUID	agent,
		bool	dumpAssetsToFile,
		string	regionName
	)			`[inline]`

Member Function Documentation

void OpenSim::Framework::Communications::Capabilities::Caps::RegisterHandlers ( ) [inline]

void OpenSim::Framework::Communications::Capabilities::Caps::RegisterHandler	(	string	capName,
		IRequestHandler	handler
	)			`[inline]`

Parameters:

	capName
	handler

void OpenSim::Framework::Communications::Capabilities::Caps::DeregisterHandlers ( ) [inline]

Remove all CAPS service handlers.

Parameters:

	httpListener
	path
	restMethod

string OpenSim::Framework::Communications::Capabilities::Caps::CapsRequest	(	string	request,
		string	path,
		string	param,
		OSHttpRequest	httpRequest,
		OSHttpResponse	httpResponse
	)			`[inline]`

Construct a client response detailing all the capabilities this server can provide.

Parameters:

	request
	path
	param
	httpRequest	HTTP request header object
	httpResponse	HTTP response header object

Returns:

string OpenSim::Framework::Communications::Capabilities::Caps::FetchInventoryRequest	(	string	request,
		string	path,
		string	param
	)			`[inline]`

Processes a fetch inventory request and sends the reply.

Parameters:

	request
	path
	param

Returns:

LLSDMapLayerResponse OpenSim::Framework::Communications::Capabilities::Caps::GetMapLayer ( LLSDMapRequest mapReq ) [inline]

Parameters:

mapReq

Returns:

static OSDMapLayer OpenSim::Framework::Communications::Capabilities::Caps::GetOSDMapLayerResponse ( ) [inline, static, protected]

Returns:

string OpenSim::Framework::Communications::Capabilities::Caps::RequestTexture	(	string	request,
		string	path,
		string	param
	)			`[inline]`

Parameters:

	request
	path
	param

Returns:

string OpenSim::Framework::Communications::Capabilities::Caps::ProcessEventQueue	(	string	request,
		string	path,
		string	param
	)			`[inline]`

Parameters:

	request
	path
	param

Returns:

string OpenSim::Framework::Communications::Capabilities::Caps::CreateEstablishAgentComms	(	string	caps,
		string	ipAddressPort
	)			`[inline]`

Parameters:

	caps
	ipAddressPort

Returns:

string OpenSim::Framework::Communications::Capabilities::Caps::CreateEmptyEventResponse ( ) [inline]

Returns:

string OpenSim::Framework::Communications::Capabilities::Caps::ScriptTaskInventory	(	string	request,
		string	path,
		string	param,
		OSHttpRequest	httpRequest,
		OSHttpResponse	httpResponse
	)			`[inline]`

Called by the script task update handler. Provides a URL to which the client can upload a new asset.

Parameters:

	request
	path
	param
	httpRequest	HTTP request header object
	httpResponse	HTTP response header object

Returns:

string OpenSim::Framework::Communications::Capabilities::Caps::NoteCardAgentInventory	(	string	request,
		string	path,
		string	param,
		OSHttpRequest	httpRequest,
		OSHttpResponse	httpResponse
	)			`[inline]`

Called by the notecard update handler. Provides a URL to which the client can upload a new asset.

Parameters:

	request
	path
	param

Returns:

LLSDAssetUploadResponse OpenSim::Framework::Communications::Capabilities::Caps::NewAgentInventoryRequest ( LLSDAssetUploadRequest llsdRequest ) [inline]

Parameters:

llsdRequest

Returns:

void OpenSim::Framework::Communications::Capabilities::Caps::UploadCompleteHandler	(	string	assetName,
		string	assetDescription,
		UUID	assetID,
		UUID	inventoryItem,
		UUID	parentFolder,
		byte[]	data,
		string	inventoryType,
		string	assetType
	)			`[inline]`

Parameters:

	assetID
	inventoryItem
	data

UUID OpenSim::Framework::Communications::Capabilities::Caps::ItemUpdated	(	UUID	itemID,
		byte[]	data
	)			`[inline]`

Called when new asset data for an agent inventory item update has been uploaded.

Parameters:

	itemID	Item to update
	data	New asset data

Returns:

void OpenSim::Framework::Communications::Capabilities::Caps::TaskScriptUpdated	(	UUID	itemID,
		UUID	primID,
		bool	isScriptRunning,
		byte[]	data
	)			`[inline]`

Called when new asset data for an agent inventory item update has been uploaded.

Parameters:

	itemID	Item to update
	primID	Prim containing item to update
	isScriptRunning	Signals whether the script to update is currently running
	data	New asset data