OpenSim
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Protected Member Functions | Static Protected Attributes | List of all members
OpenSim.Services.HypergridService.UserAgentService Class Reference

This service is for HG1.5 only, to make up for the fact that clients don't keep any private information in themselves, and that their 'home service' needs to do it for them. Once we have better clients, this shouldn't be needed. More...

Inheritance diagram for OpenSim.Services.HypergridService.UserAgentService:
Inheritance graph
[legend]
Collaboration diagram for OpenSim.Services.HypergridService.UserAgentService:
Collaboration graph
[legend]

Public Member Functions

 UserAgentService (IConfigSource config)
 
 UserAgentService (IConfigSource config, IFriendsSimConnector friendsConnector)
 
GridRegion GetHomeRegion (UUID userID, out Vector3 position, out Vector3 lookAt)
 Returns the home region of a remote user. More...
 
bool LoginAgentToGrid (GridRegion source, AgentCircuitData agentCircuit, GridRegion gatekeeper, GridRegion finalDestination, bool fromLogin, out string reason)
 
bool LoginAgentToGrid (GridRegion source, AgentCircuitData agentCircuit, GridRegion gatekeeper, GridRegion finalDestination, out string reason)
 
void LogoutAgent (UUID userID, UUID sessionID)
 
bool IsAgentComingHome (UUID sessionID, string thisGridExternalName)
 
bool VerifyClient (UUID sessionID, string reportedIP)
 
bool VerifyAgent (UUID sessionID, string token)
 
List< UUID > StatusNotification (List< string > friends, UUID foreignUserID, bool online)
 
List< UUID > GetOnlineFriends (UUID foreignUserID, List< string > friends)
 
Dictionary< string, object > GetUserInfo (UUID userID)
 Returns the UserInfo of a remote user. More...
 
Dictionary< string, object > GetServerURLs (UUID userID)
 Returns the Server URLs of a remote user. More...
 
string LocateUser (UUID userID)
 Returns the current location of a remote user. More...
 
string GetUUI (UUID userID, UUID targetUserID)
 Returns the Universal User Identifier for 'targetUserID' on behalf of 'userID'. More...
 
UUID GetUUID (String first, String last)
 Returns the remote user that has the given name. More...
 
- Public Member Functions inherited from OpenSim.Services.HypergridService.UserAgentServiceBase
 UserAgentServiceBase (IConfigSource config)
 
- Public Member Functions inherited from OpenSim.Services.Base.ServiceBase
LoadPlugin< T > (string dllName)
 
LoadPlugin< T > (string dllName, Object[] args)
 
LoadPlugin< T > (string dllName, string className, Object[] args)
 
 ServiceBase (IConfigSource config)
 

Protected Member Functions

void LoadTripPermissionsFromConfig (IConfig config, string variable)
 
void LoadDomainExceptionsFromConfig (IConfig config, string variable, Dictionary< int, List< string >> exceptions)
 
void ForwardStatusNotificationToSim (UUID regionID, UUID foreignUserID, string user, bool online)
 

Static Protected Attributes

static IGridUserService m_GridUserService
 
static IGridService m_GridService
 
static GatekeeperServiceConnector m_GatekeeperConnector
 
static IGatekeeperService m_GatekeeperService
 
static IFriendsService m_FriendsService
 
static IPresenceService m_PresenceService
 
static IUserAccountService m_UserAccountService
 
static IFriendsSimConnector m_FriendsLocalSimConnector
 
static FriendsSimConnector m_FriendsSimConnector
 
static string m_GridName
 
static int m_LevelOutsideContacts
 
static bool m_ShowDetails
 
static bool m_BypassClientVerification
 

Additional Inherited Members

- Protected Attributes inherited from OpenSim.Services.HypergridService.UserAgentServiceBase
IHGTravelingData m_Database = null
 

Detailed Description

This service is for HG1.5 only, to make up for the fact that clients don't keep any private information in themselves, and that their 'home service' needs to do it for them. Once we have better clients, this shouldn't be needed.

Definition at line 54 of file UserAgentService.cs.

Constructor & Destructor Documentation

OpenSim.Services.HypergridService.UserAgentService.UserAgentService ( IConfigSource  config)
inline

Definition at line 86 of file UserAgentService.cs.

OpenSim.Services.HypergridService.UserAgentService.UserAgentService ( IConfigSource  config,
IFriendsSimConnector  friendsConnector 
)
inline

Definition at line 90 of file UserAgentService.cs.

Member Function Documentation

void OpenSim.Services.HypergridService.UserAgentService.ForwardStatusNotificationToSim ( UUID  regionID,
UUID  foreignUserID,
string  user,
bool  online 
)
inlineprotected

Definition at line 488 of file UserAgentService.cs.

GridRegion OpenSim.Services.HypergridService.UserAgentService.GetHomeRegion ( UUID  userID,
out Vector3  position,
out Vector3  lookAt 
)
inline

Returns the home region of a remote user.

Returns
On success: the user's home region. If the user doesn't exist: null.

Throws an exception if an error occurs (e.g., can't contact the server).

Implements OpenSim.Services.Interfaces.IUserAgentService.

Definition at line 193 of file UserAgentService.cs.

List<UUID> OpenSim.Services.HypergridService.UserAgentService.GetOnlineFriends ( UUID  foreignUserID,
List< string >  friends 
)
inline

Definition at line 510 of file UserAgentService.cs.

Dictionary<string, object> OpenSim.Services.HypergridService.UserAgentService.GetServerURLs ( UUID  userID)
inline

Returns the Server URLs of a remote user.

Returns
On success: the user's Server URLs. If the user doesn't exist: an empty dictionary.

Throws an exception if an error occurs (e.g., can't contact the server).

!!

Implements OpenSim.Services.Interfaces.IUserAgentService.

Definition at line 599 of file UserAgentService.cs.

Dictionary<string, object> OpenSim.Services.HypergridService.UserAgentService.GetUserInfo ( UUID  userID)
inline

Returns the UserInfo of a remote user.

Returns
On success: the user's UserInfo. If the user doesn't exist: an empty dictionary.

Throws an exception if an error occurs (e.g., can't contact the server).

!!

Implements OpenSim.Services.Interfaces.IUserAgentService.

Definition at line 562 of file UserAgentService.cs.

string OpenSim.Services.HypergridService.UserAgentService.GetUUI ( UUID  userID,
UUID  targetUserID 
)
inline

Returns the Universal User Identifier for 'targetUserID' on behalf of 'userID'.

Returns
On success: the user's UUI. If the user doesn't exist: "".

Throws an exception if an error occurs (e.g., can't contact the server).

Implements OpenSim.Services.Interfaces.IUserAgentService.

Definition at line 626 of file UserAgentService.cs.

UUID OpenSim.Services.HypergridService.UserAgentService.GetUUID ( String  first,
String  last 
)
inline

Returns the remote user that has the given name.

Returns
On success: the user's UUID. If the user doesn't exist: UUID.Zero.

Throws an exception if an error occurs (e.g., can't contact the server).

Implements OpenSim.Services.Interfaces.IUserAgentService.

Definition at line 650 of file UserAgentService.cs.

bool OpenSim.Services.HypergridService.UserAgentService.IsAgentComingHome ( UUID  sessionID,
string  thisGridExternalName 
)
inline
void OpenSim.Services.HypergridService.UserAgentService.LoadDomainExceptionsFromConfig ( IConfig  config,
string  variable,
Dictionary< int, List< string >>  exceptions 
)
inlineprotected

Definition at line 172 of file UserAgentService.cs.

void OpenSim.Services.HypergridService.UserAgentService.LoadTripPermissionsFromConfig ( IConfig  config,
string  variable 
)
inlineprotected

Definition at line 159 of file UserAgentService.cs.

string OpenSim.Services.HypergridService.UserAgentService.LocateUser ( UUID  userID)
inline

Returns the current location of a remote user.

Returns
On success: the user's Server URLs. If the user doesn't exist: "".

Throws an exception if an error occurs (e.g., can't contact the server).

Implements OpenSim.Services.Interfaces.IUserAgentService.

Definition at line 613 of file UserAgentService.cs.

bool OpenSim.Services.HypergridService.UserAgentService.LoginAgentToGrid ( GridRegion  source,
AgentCircuitData  agentCircuit,
GridRegion  gatekeeper,
GridRegion  finalDestination,
bool  fromLogin,
out string  reason 
)
inline
bool OpenSim.Services.HypergridService.UserAgentService.LoginAgentToGrid ( GridRegion  source,
AgentCircuitData  agentCircuit,
GridRegion  gatekeeper,
GridRegion  finalDestination,
out string  reason 
)
inline

Definition at line 313 of file UserAgentService.cs.

void OpenSim.Services.HypergridService.UserAgentService.LogoutAgent ( UUID  userID,
UUID  sessionID 
)
inline
List<UUID> OpenSim.Services.HypergridService.UserAgentService.StatusNotification ( List< string >  friends,
UUID  foreignUserID,
bool  online 
)
inline
bool OpenSim.Services.HypergridService.UserAgentService.VerifyAgent ( UUID  sessionID,
string  token 
)
inline
bool OpenSim.Services.HypergridService.UserAgentService.VerifyClient ( UUID  sessionID,
string  reportedIP 
)
inline

Member Data Documentation

bool OpenSim.Services.HypergridService.UserAgentService.m_BypassClientVerification
staticprotected

Definition at line 80 of file UserAgentService.cs.

IFriendsSimConnector OpenSim.Services.HypergridService.UserAgentService.m_FriendsLocalSimConnector
staticprotected

Definition at line 72 of file UserAgentService.cs.

IFriendsService OpenSim.Services.HypergridService.UserAgentService.m_FriendsService
staticprotected

Definition at line 69 of file UserAgentService.cs.

FriendsSimConnector OpenSim.Services.HypergridService.UserAgentService.m_FriendsSimConnector
staticprotected

Definition at line 73 of file UserAgentService.cs.

GatekeeperServiceConnector OpenSim.Services.HypergridService.UserAgentService.m_GatekeeperConnector
staticprotected

Definition at line 67 of file UserAgentService.cs.

IGatekeeperService OpenSim.Services.HypergridService.UserAgentService.m_GatekeeperService
staticprotected

Definition at line 68 of file UserAgentService.cs.

string OpenSim.Services.HypergridService.UserAgentService.m_GridName
staticprotected

Definition at line 75 of file UserAgentService.cs.

IGridService OpenSim.Services.HypergridService.UserAgentService.m_GridService
staticprotected

Definition at line 66 of file UserAgentService.cs.

IGridUserService OpenSim.Services.HypergridService.UserAgentService.m_GridUserService
staticprotected

Definition at line 65 of file UserAgentService.cs.

int OpenSim.Services.HypergridService.UserAgentService.m_LevelOutsideContacts
staticprotected

Definition at line 77 of file UserAgentService.cs.

IPresenceService OpenSim.Services.HypergridService.UserAgentService.m_PresenceService
staticprotected

Definition at line 70 of file UserAgentService.cs.

bool OpenSim.Services.HypergridService.UserAgentService.m_ShowDetails
staticprotected

Definition at line 78 of file UserAgentService.cs.

IUserAccountService OpenSim.Services.HypergridService.UserAgentService.m_UserAccountService
staticprotected

Definition at line 71 of file UserAgentService.cs.


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