OpenSim
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Properties | List of all members
OpenSim.Framework.Capabilities.Caps Class Reference

Public Member Functions

 Caps (IHttpServer httpServer, string httpListen, uint httpPort, string capsPath, UUID agent, string regionName)
 
void RegisterHandler (string capName, IRequestHandler handler)
 Register a handler. This allows modules to register handlers. More...
 
void RegisterPollHandler (string capName, PollServiceEventArgs pollServiceHandler)
 
void RegisterHandler (string capsName, string url)
 Register an external handler. The service for this capability is somewhere else given by the URL. More...
 
void DeregisterHandlers ()
 Remove all CAPS service handlers. More...
 
bool TryGetPollHandler (string name, out PollServiceEventArgs pollHandler)
 
Dictionary< string,
PollServiceEventArgs
GetPollHandlers ()
 
Hashtable GetCapsDetails (bool excludeSeed, List< string > requestedCaps)
 Return an LLSD-serializable Hashtable describing the capabilities and their handler details. More...
 
void Activate ()
 
bool WaitForActivation ()
 

Properties

string CapsObjectPath [get]
 
UUID AgentID [get]
 
string RegionName [get]
 
string HostName [get]
 
uint Port [get]
 
IHttpServer HttpListener [get]
 
bool SSLCaps [get]
 
string SSLCommonName [get]
 
CapsHandlers CapsHandlers [get]
 
Dictionary< string, string > ExternalCapsHandlers [get]
 

Detailed Description

Definition at line 52 of file Caps.cs.

Constructor & Destructor Documentation

OpenSim.Framework.Capabilities.Caps.Caps ( IHttpServer  httpServer,
string  httpListen,
uint  httpPort,
string  capsPath,
UUID  agent,
string  regionName 
)
inline

Definition at line 122 of file Caps.cs.

Member Function Documentation

void OpenSim.Framework.Capabilities.Caps.Activate ( )
inline

Definition at line 262 of file Caps.cs.

void OpenSim.Framework.Capabilities.Caps.DeregisterHandlers ( )
inline

Remove all CAPS service handlers.

Definition at line 194 of file Caps.cs.

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

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

Parameters
excludeSeedIf true, then exclude the seed cap.

Definition at line 222 of file Caps.cs.

Dictionary<string, PollServiceEventArgs> OpenSim.Framework.Capabilities.Caps.GetPollHandlers ( )
inline

Definition at line 212 of file Caps.cs.

void OpenSim.Framework.Capabilities.Caps.RegisterHandler ( string  capName,
IRequestHandler  handler 
)
inline

Register a handler. This allows modules to register handlers.

Parameters
capName
handler

Definition at line 149 of file Caps.cs.

void OpenSim.Framework.Capabilities.Caps.RegisterHandler ( string  capsName,
string  url 
)
inline

Register an external handler. The service for this capability is somewhere else given by the URL.

Parameters
capsName
url

Definition at line 186 of file Caps.cs.

void OpenSim.Framework.Capabilities.Caps.RegisterPollHandler ( string  capName,
PollServiceEventArgs  pollServiceHandler 
)
inline

Definition at line 155 of file Caps.cs.

bool OpenSim.Framework.Capabilities.Caps.TryGetPollHandler ( string  name,
out PollServiceEventArgs  pollHandler 
)
inline

Definition at line 207 of file Caps.cs.

bool OpenSim.Framework.Capabilities.Caps.WaitForActivation ( )
inline

Definition at line 267 of file Caps.cs.

Property Documentation

UUID OpenSim.Framework.Capabilities.Caps.AgentID
get

Definition at line 78 of file Caps.cs.

CapsHandlers OpenSim.Framework.Capabilities.Caps.CapsHandlers
get

Definition at line 113 of file Caps.cs.

string OpenSim.Framework.Capabilities.Caps.CapsObjectPath
get

Definition at line 63 of file Caps.cs.

Dictionary<string, string> OpenSim.Framework.Capabilities.Caps.ExternalCapsHandlers
get

Definition at line 118 of file Caps.cs.

string OpenSim.Framework.Capabilities.Caps.HostName
get

Definition at line 88 of file Caps.cs.

IHttpServer OpenSim.Framework.Capabilities.Caps.HttpListener
get

Definition at line 98 of file Caps.cs.

uint OpenSim.Framework.Capabilities.Caps.Port
get

Definition at line 93 of file Caps.cs.

string OpenSim.Framework.Capabilities.Caps.RegionName
get

Definition at line 83 of file Caps.cs.

bool OpenSim.Framework.Capabilities.Caps.SSLCaps
get

Definition at line 103 of file Caps.cs.

string OpenSim.Framework.Capabilities.Caps.SSLCommonName
get

Definition at line 108 of file Caps.cs.


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