OpenSim.Framework.Capabilities.CapsHandlers Class Reference

CapsHandlers is a cap handler container but also takes care of adding and removing cap handlers to and from the supplied BaseHttpServer. More...

Public Member Functions
	CapsHandlers (BaseHttpServer httpListener, string httpListenerHostname, uint httpListenerPort)
	CapsHandlers (IHttpServer httpListener, string httpListenerHostname, uint httpListenerPort, bool https)
void	Remove (string capsName)
	Remove the cap handler for a capability. More...
bool	ContainsCap (string cap)
Hashtable	GetCapsDetails (bool excludeSeed, List< string > requestedCaps)
	Return an LLSD-serializable Hashtable describing the capabilities and their handler details. More...
Dictionary< string, IRequestHandler >	GetCapsHandlers ()
	Returns a copy of the dictionary of all the HTTP cap handlers More...

Properties
IRequestHandler	this[string idx] [get, set]
	The indexer allows us to treat the CapsHandlers object in an intuitive dictionary like way. More...
string[]	Caps [get]
	Return the list of cap names for which this CapsHandlers object contains cap handlers. More...

Detailed Description

CapsHandlers is a cap handler container but also takes care of adding and removing cap handlers to and from the supplied BaseHttpServer.

Definition at line 40 of file CapsHandlers.cs.

Constructor & Destructor Documentation

OpenSim.Framework.Capabilities.CapsHandlers.CapsHandlers ( BaseHttpServer  httpListener, string  httpListenerHostname, uint  httpListenerPort  )

inline

CapsHandlers is a cap handler container but also takes care of adding and removing cap handlers to and from the supplied BaseHttpServer.

Parameters

httpListener	base HTTP server
httpListenerHostname	host name of the HTTP server
httpListenerPort	HTTP port

Definition at line 56 of file CapsHandlers.cs.

OpenSim.Framework.Capabilities.CapsHandlers.CapsHandlers ( IHttpServer  httpListener, string  httpListenerHostname, uint  httpListenerPort, bool  https  )

inline

CapsHandlers is a cap handler container but also takes care of adding and removing cap handlers to and from the supplied BaseHttpServer.

Parameters

httpListener	base HTTP server
httpListenerHostname	host name of the HTTP server
httpListenerPort	HTTP port

Definition at line 70 of file CapsHandlers.cs.

Member Function Documentation

bool OpenSim.Framework.Capabilities.CapsHandlers.ContainsCap ( string  cap )

inline

Definition at line 99 of file CapsHandlers.cs.

Hashtable OpenSim.Framework.Capabilities.CapsHandlers.GetCapsDetails ( bool  excludeSeed, List< string >  requestedCaps  )

inline

Return an LLSD-serializable Hashtable describing the capabilities and their handler details.

Parameters

excludeSeed

If true, then exclude the seed cap.

Definition at line 162 of file CapsHandlers.cs.

Dictionary<string, IRequestHandler> OpenSim.Framework.Capabilities.CapsHandlers.GetCapsHandlers ( )

inline

Returns a copy of the dictionary of all the HTTP cap handlers

Returns

The dictionary copy. The key is the capability name, the value is the HTTP handler.

Definition at line 195 of file CapsHandlers.cs.

void OpenSim.Framework.Capabilities.CapsHandlers.Remove ( string  capsName )

inline

Remove the cap handler for a capability.

Parameters

capsName

name of the capability of the cap handler to be removed

Definition at line 88 of file CapsHandlers.cs.

Property Documentation

string [] OpenSim.Framework.Capabilities.CapsHandlers.Caps

get

Return the list of cap names for which this CapsHandlers object contains cap handlers.

Definition at line 145 of file CapsHandlers.cs.

IRequestHandler OpenSim.Framework.Capabilities.CapsHandlers.this[string idx]

getset

The indexer allows us to treat the CapsHandlers object in an intuitive dictionary like way.

The indexer will throw an exception when you try to retrieve a cap handler for a cap that is not contained in CapsHandlers.

Definition at line 115 of file CapsHandlers.cs.

---

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

• Capabilities/CapsHandlers.cs