OpenSim
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | List of all members
OpenSim.Services.Interfaces.IGatekeeperService Interface Reference
Inheritance diagram for OpenSim.Services.Interfaces.IGatekeeperService:
Inheritance graph
[legend]

Public Member Functions

bool LinkRegion (string regionDescriptor, out UUID regionID, out ulong regionHandle, out string externalName, out string imageURL, out string reason)
 
GridRegion GetHyperlinkRegion (UUID regionID, UUID agentID, string agentHomeURI, out string message)
 Returns the region a Hypergrid visitor should enter. More...
 
bool LoginAgent (GridRegion source, AgentCircuitData aCircuit, GridRegion destination, out string reason)
 

Detailed Description

Definition at line 37 of file IHypergridServices.cs.

Member Function Documentation

GridRegion OpenSim.Services.Interfaces.IGatekeeperService.GetHyperlinkRegion ( UUID  regionID,
UUID  agentID,
string  agentHomeURI,
out string  message 
)

Returns the region a Hypergrid visitor should enter.

Usually the returned region will be the requested region. But the grid can choose to redirect the user to another region: e.g., a default gateway region.

Parameters
regionIDThe region the visitor wants to enter
agentIDThe visitor's User ID. Will be missing (UUID.Zero) in older OpenSims.
agentHomeURIThe visitor's Home URI. Will be missing (null) in older OpenSims.
message[out] A message to show to the user (optional, may be null)
Returns
The region the visitor should enter, or null if no region can be found / is allowed

Implemented in OpenSim.Services.HypergridService.GatekeeperService.

bool OpenSim.Services.Interfaces.IGatekeeperService.LinkRegion ( string  regionDescriptor,
out UUID  regionID,
out ulong  regionHandle,
out string  externalName,
out string  imageURL,
out string  reason 
)
bool OpenSim.Services.Interfaces.IGatekeeperService.LoginAgent ( GridRegion  source,
AgentCircuitData  aCircuit,
GridRegion  destination,
out string  reason 
)

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